Skip to main content

Get a security rule by its name contained into a security group

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

Get the Security Rule resource with its name in the path.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

    securityGroupId stringrequired

    Security Group Identifier

    securityRuleName stringrequired

    Name of the security rule

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

Schema

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