Security Group

This page describes operations you can perform on security-groups. List, create, get details for, update, and delete.

List Security Group

List all visible security-groups.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/security-groups

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
description query string - - Security group description. no
id query string hyph-uuid - Security group unique id. no
name query string - - Security group name. no
status query string - - Security group status. no
tenant_id query string non-hyph-uuid-or-empty - The owner name of security group. no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
security-groups array<object> Security Group -
description string - Security group description.
id string hyph-uuid Security group unique id.
name string - Security group name.
security_group_rules array<object> - Security group rules
description string - Security group rule description.
direction string - Direction in which the security group rule is applied.
ethertype string - It should be IPv4 or IPv6. If specified, addresses represented in CIDR must match this value.
id string hyph-uuid Security group rule unique id.
port_range_max integer - The maximum port number in the range that is matched by the security group rule.
port_range_min integer - The minimum port number in the range that is matched by the security group rule.
protocol string - Protocol name or number in string format. e.g. "ICMP" or "1"
remote_group_id string hyph-uuid The remote group UUID to associate with this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.
remote_ip_prefix string - The remote IP prefix that is matched by this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.
security_group_id string hyph-uuid Security group id.
tenant_id string non-hyph-uuid-or-empty The owner name of security group rule.
status string - Security group status.
tags object - Security Group tags.
tenant_id string non-hyph-uuid-or-empty The owner name of security group.

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

Only when you customize, return value includes entry like below.

{
  "security_groups": [
    {
      "description": "Example security group 1 description.",
      "id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
      "name": "Example security group 1",
      "security_group_rules": [
        {
          "description": "Example security group rule 1 description.",
          "direction": "ingress",
          "ethertype": "IPv4",
          "id": "830b1b3a-d159-4e4b-b43b-4ba62bf46bb8",
          "port_range_max": 65535,
          "port_range_min": 0,
          "protocol": "ip",
          "remote_group_id": null,
          "remote_ip_prefix": "192.168.100.0/24",
          "security_group_id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
          "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
        }
      ],
      "status": "ACTIVE",
      "tags": {},
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "description": "Example security group 2 description.",
      "id": "f80a5f90-7c5d-472b-9eb4-c2160cfa29e3",
      "name": "Example security group 2",
      "security_group_rules": [
        {
          "description": "Example security group rule 2 description.",
          "direction": "egress",
          "ethertype": "IPv4",
          "id": "cbfb59f0-30ba-4714-829b-373f13cf8962",
          "port_range_max": 65535,
          "port_range_min": 0,
          "protocol": "1",
          "remote_group_id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
          "remote_ip_prefix": null,
          "security_group_id": "f80a5f90-7c5d-472b-9eb4-c2160cfa29e3",
          "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
        }
      ],
      "status": "ACTIVE",
      "tags": {},
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Create Security Group

Create security-group.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{endpoint}/v2.0/security-groups

HTTP Request Parameters

Parameter Style Type Format Enumeration Default Description Required
security_group plain object Security Group - - - yes
description plain string - - "" Security group description. no
name plain string - - "" Security group name. no
tags plain object - - {} Security Group tags. no
tenant_id plain string non-hyph-uuid-or-empty - See notes. The owner name of security group. no

注釈

tenant_id: The ID of default tenant to which user belongs.

Response

HTTP Response Code List

Response Code Description
201 OK
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
security_group object Security Group -
description string - Security group description.
id string hyph-uuid Security group unique id.
name string - Security group name.
security_group_rules array<object> - Security group rules
status string - Security group status.
tags object - Security Group tags.
tenant_id string non-hyph-uuid-or-empty The owner name of security group.

Examples

Sample Request Body

{
  "security_group": {
    "description": "Example security group 1 description.",
    "name": "Example security group 1",
    "tags": {},
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Sample Response Body

{
  "security_group": {
    "description": "Example security group 1 description.",
    "id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
    "name": "Example security group 1",
    "security_group_rules": [],
    "status": "PENDING_CREATE",
    "tags": {},
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Show Security Group

Show details for security-group.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/security-groups/{security_group_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
security_group_id URI string hyph-uuid - Security group unique id. yes

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
security_group object Security Group -
description string - Security group description.
id string hyph-uuid Security group unique id.
name string - Security group name.
security_group_rules array<object> - Security group rules
description string - Security group rule description.
direction string - Direction in which the security group rule is applied.
ethertype string - It should be IPv4 or IPv6. If specified, addresses represented in CIDR must match this value.
id string hyph-uuid Security group rule unique id.
port_range_max integer - The maximum port number in the range that is matched by the security group rule.
port_range_min integer - The minimum port number in the range that is matched by the security group rule.
protocol string - Protocol name or number in string format. e.g. "ICMP" or "1"
remote_group_id string hyph-uuid The remote group UUID to associate with this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.
remote_ip_prefix string - The remote IP prefix that is matched by this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.
security_group_id string hyph-uuid Security group id.
tenant_id string non-hyph-uuid-or-empty The owner name of security group rule.
status string - Security group status.
tags object - Security Group tags.
tenant_id string non-hyph-uuid-or-empty The owner name of security group.

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "security_group": {
    "description": "Example security group 1 description.",
    "id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
    "name": "Example security group 1",
    "security_group_rules": [
      {
        "description": "Example security group rule 1 description.",
        "direction": "ingress",
        "ethertype": "IPv4",
        "id": "830b1b3a-d159-4e4b-b43b-4ba62bf46bb8",
        "port_range_max": 65535,
        "port_range_min": 0,
        "protocol": "ip",
        "remote_group_id": null,
        "remote_ip_prefix": "192.168.100.0/24",
        "security_group_id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
        "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
      }
    ],
    "status": "ACTIVE",
    "tags": {},
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Update Security Group

Update security-group.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{endpoint}/v2.0/security-groups/{security_group_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
security_group_id URI string hyph-uuid - Security group unique id. yes
security_group plain object Security Group - - yes
description plain string - - Security group description. no
name plain string - - Security group name. no
tags plain object - - Security Group tags. no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
security_group object Security Group -
description string - Security group description.
id string hyph-uuid Security group unique id.
name string - Security group name.
security_group_rules array<object> - Security group rules
description string - Security group rule description.
direction string - Direction in which the security group rule is applied.
ethertype string - It should be IPv4 or IPv6. If specified, addresses represented in CIDR must match this value.
id string hyph-uuid Security group rule unique id.
port_range_max integer - The maximum port number in the range that is matched by the security group rule.
port_range_min integer - The minimum port number in the range that is matched by the security group rule.
protocol string - Protocol name or number in string format. e.g. "ICMP" or "1"
remote_group_id string hyph-uuid The remote group UUID to associate with this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.
remote_ip_prefix string - The remote IP prefix that is matched by this security group rule. Only either one of remote_group_id and remote_ip_prefix have to be specified.
security_group_id string hyph-uuid Security group id.
tenant_id string non-hyph-uuid-or-empty The owner name of security group rule.
status string - Security group status.
tags object - Security Group tags.
tenant_id string non-hyph-uuid-or-empty The owner name of security group.

Examples

Sample Request Body

{
  "security_group": {
    "description": "Example security group 1 description.",
    "name": "Example security group 1",
    "tags": {}
  }
}

Sample Response Body

{
  "security_group": {
    "description": "Example security group 1 description.",
    "id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
    "name": "Example security group 1",
    "security_group_rules": [
      {
        "description": "Example security group rule 1 description.",
        "direction": "ingress",
        "ethertype": "IPv4",
        "id": "830b1b3a-d159-4e4b-b43b-4ba62bf46bb8",
        "port_range_max": 65535,
        "port_range_min": 0,
        "protocol": "ip",
        "remote_group_id": null,
        "remote_ip_prefix": "192.168.100.0/24",
        "security_group_id": "5a79909b-2bf3-4e26-8a9c-0bf6bb175457",
        "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
      }
    ],
    "status": "PENDING_UPDATE",
    "tags": {},
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Delete Security Group

Delete security-group.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • DELETE

HTTP Request Path

{endpoint}/v2.0/security-groups/{security_group_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
security_group_id URI string hyph-uuid - Security group unique id. yes

Response

HTTP Response Code List

Response Code Description
204 No Content
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

This operation does not receive a response body.

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

This operation does not receive a response body.

Physical Port
Security Group Rule