Skip to main content

Find security groups by searching criteria.

GET 
/v1/projects/:projectId/zones/:zoneName/securitygroups

Return security groups that match all searching criteria. Criteria are project identifier and security groups name.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

Query Parameters

    name string

    Name of the resource.

    provisioningState BasicStateEnum

    Possible values: [creating, updating, deleting, active, error]

    State of the searched security group.

    offset int32

    Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.

    Default value: 0
    limit int32

    Possible values: >= 1

    Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).

    Default value: 100
    sort string

    Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

    The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

Header Parameters

    X-API-KEY string

    Your SIU token if you use this API through Orange Developer.

    Authorization string

    Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

    X-Requester-Id string

    Your SIU Id if you use this API through Orange Developer Inside.

Responses​

Ok

Response Headers
    X-Total-Count

    Returns Pagination of response. The total number of items in the collection, after application of filters if any.

    X-Result-Count

    The actual number of items contained in the response body. Note that it can be less than the requested "limit".

Schema
  • Array [
    • namestringrequired

    Unique resource name. This attribute can not be updated.

    Possible values: Value must match regular expression [A-Za-z0-9-]

    descriptionstring

    Resource description

    tags object

    Tags associated with the resource

    property name*string
    iduuidrequired

    Resource identifier.

    hRefurirequired

    Hypertext reference of the resource.

    createdDatedate-timerequired

    Creation date of the resource.

    lastModifiedDatedate-timerequired

    Date of the last modification of the resource.

    lastRequesterIdstringrequired

    Identifier of the user of the last create/update/delete operation requested on the resource.

    provisioningStateBasicStateEnum (string)required

    Provisioning state of the resource. Possible state:

    • creating: resource creation in progress
    • updating: resource update in progress
    • deleting: resource deletion in progress
    • active: resource created/updated successfully
    • error: resource in error because the last creation/update/deletion failed

    Possible values: [creating, updating, deleting, active, error]

    securityRules object[]required

    List of IP filtering rules of the security group. NB: temporary impact on modification.

    Possible values: >= 1

  • Array [
    • hRefurirequired

    Hypertext reference to the Security Rule details.

    namestringrequired

    Name of the security rule. Must be unique within the Security Group. Cannot be updated.

    Possible values: <= 40 characters, Value must match regular expression [-_a-zA-Z0-9]

    descriptionstring

    Description of the security rule.

    matchRemoteIpSubnetsstring[]required

    List of remote IP subnets to match, in CIDR format.

    Possible values: >= 1, <= 10

    matchDirectionsSecurityRuleDirectionEnum (string)[]required

    List of directions to match.

    Possible values: [ingress, egress], >= 1, <= 9

    matchProtocolsstring[]

    List of protocols to match. Possible values: ah, dccp, egp, esp, gre, icmp, igmp, ipip, ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp... or numerical values.

    Possible values: <= 9

    matchPortRangesstring[]

    List of port ranges to match. Item format : ["port_range_min-port_range_max"]. For ICMP protocol, use port_range_min for the ICMP type and port_range_max for the ICMP code.

    Possible values: <= 10

  • ]
  • ]
curl -L '/v1/projects/:projectId/zones/:zoneName/securitygroups' \
-H 'Accept: application/json'
Request Collapse all
Base URL
/v1
Parameters
— pathrequired
— pathrequired
— query
— query
— query
— query
— query
— header
— header
— header