Skip to main content

find securityRule

GET 
/projects/:projectId/zones/:zoneName/securitygroups/:securityGroupId/securityrules

Return security rules that match all searching criteria.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

    securityGroupId stringrequired

    Security Group Identifier

Query Parameters

    name string

    Name of the resource.

    offset int32

    Default value: 0

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

    limit int32

    Possible values: >= 1

    Default value: 100

    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).

    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

    integer

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

  • X-Result-Count

    integer

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

Schema

  • Array [

    • hRef urirequired

    Hypertext reference to the Security Rule details.

    name stringrequired

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

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

    description string

    Description of the security rule.

    matchRemoteIpSubnets string[]required

    Possible values: >= 1, <= 10

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

    matchDirections SecurityRuleDirectionEnum (string)[]required

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

    List of directions to match.

    matchProtocols string[]

    Possible values: <= 9

    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.

    matchPortRanges string[]

    Possible values: <= 10

    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.

  • ]

Loading...