Public IPs

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

List Public Ip

List all visible public_ips.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/public_ips

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
cidr query string - - The IP address of the block (assigned automatically) no
description query string - - Description of the Public IPs no
id query string hyph-uuid - Unique ID of the Public IPs no
internet_gw_id query string hyph-uuid-or-empty - Internet Gateway the block will be assigned to no
name query string - - Name of the Public IPs no
status query string - - Public IP status. no
submask_length query integer - - Specifies the size of the block by the length of its subnetwork mask length no
tenant_id query string non-hyph-uuid - Tenant ID of the owner (UUID) 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
public_ips array<object> Public IPs -
cidr string - The IP address of the block (assigned automatically)
description string - Description of the Public IPs
id string hyph-uuid Unique ID of the Public IPs
internet_gw_id string hyph-uuid-or-empty Internet Gateway the block will be assigned to
name string - Name of the Public IPs
status string - Public IP status.
submask_length integer - Specifies the size of the block by the length of its subnetwork mask length
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "public_ips": [
    {
      "cidr": "100.127.255.80",
      "description": "",
      "id": "0718a31b-67be-4349-946b-61a0fc38e4cd",
      "internet_gw_id": "2a75cfa6-89af-425b-bce5-2a85197ef04f",
      "name": "seinou-test-public",
      "status": "ACTIVE",
      "submask_length": 28,
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "cidr": "100.127.254.56",
      "description": "",
      "id": "110846c3-3a20-42ff-ad3d-25ba7b0272bb",
      "internet_gw_id": "05db9b0e-65ed-4478-a6b3-d3fc259c8d07",
      "name": "6_Public",
      "status": "ACTIVE",
      "submask_length": 29,
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Create Public Ip

Create public_ip.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{endpoint}/v2.0/public_ips

HTTP Request Parameters

Parameter Style Type Format Enumeration Default Description Required
public_ip plain object Public IPs - - - yes
description plain string - - “” Description of the Public IPs no
internet_gw_id plain string hyph-uuid-or-empty - - Internet Gateway the block will be assigned to yes
name plain string - - “” Name of the Public IPs no
submask_length plain integer - - - Specifies the size of the block by the length of its subnetwork mask length yes
tenant_id plain string non-hyph-uuid - See notes. Tenant ID of the owner (UUID) no

Note

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

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
public_ip object Public IPs -
cidr string - The IP address of the block (assigned automatically)
description string - Description of the Public IPs
id string hyph-uuid Unique ID of the Public IPs
internet_gw_id string hyph-uuid-or-empty Internet Gateway the block will be assigned to
name string - Name of the Public IPs
status string - Public IP status.
submask_length integer - Specifies the size of the block by the length of its subnetwork mask length
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)

Examples

Sample Request Body

{
  "public_ip": {
    "description": "",
    "internet_gw_id": "2a75cfa6-89af-425b-bce5-2a85197ef04f",
    "name": "seinou-test-public",
    "submask_length": 28,
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Sample Response Body

{
  "public_ip": {
    "cidr": "100.127.255.80",
    "description": "",
    "id": "0718a31b-67be-4349-946b-61a0fc38e4cd",
    "internet_gw_id": "2a75cfa6-89af-425b-bce5-2a85197ef04f",
    "name": "seinou-test-public",
    "status": "PENDING_CREATE",
    "submask_length": 28,
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Show Public Ip

Show details for public_ip.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/public_ips/{public_ip_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
public_ip_id URI string hyph-uuid - Unique ID of the Public IPs 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
public_ip object Public IPs -
cidr string - The IP address of the block (assigned automatically)
description string - Description of the Public IPs
id string hyph-uuid Unique ID of the Public IPs
internet_gw_id string hyph-uuid-or-empty Internet Gateway the block will be assigned to
name string - Name of the Public IPs
status string - Public IP status.
submask_length integer - Specifies the size of the block by the length of its subnetwork mask length
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "public_ip": {
    "cidr": "100.127.255.80",
    "description": "",
    "id": "0718a31b-67be-4349-946b-61a0fc38e4cd",
    "internet_gw_id": "2a75cfa6-89af-425b-bce5-2a85197ef04f",
    "name": "seinou-test-public",
    "status": "ACTIVE",
    "submask_length": 28,
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Update Public Ip

Update public_ip.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{endpoint}/v2.0/public_ips/{public_ip_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
public_ip_id URI string hyph-uuid - Unique ID of the Public IPs yes
public_ip plain object Public IPs - - yes
description plain string - - Description of the Public IPs no
name plain string - - Name of the Public IPs 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
public_ip object Public IPs -
cidr string - The IP address of the block (assigned automatically)
description string - Description of the Public IPs
id string hyph-uuid Unique ID of the Public IPs
internet_gw_id string hyph-uuid-or-empty Internet Gateway the block will be assigned to
name string - Name of the Public IPs
status string - Public IP status.
submask_length integer - Specifies the size of the block by the length of its subnetwork mask length
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)

Examples

Sample Request Body

{
  "public_ip": {
    "description": "",
    "name": "seinou-test-public"
  }
}

Sample Response Body

{
  "public_ip": {
    "cidr": "100.127.255.80",
    "description": "",
    "id": "0718a31b-67be-4349-946b-61a0fc38e4cd",
    "internet_gw_id": "2a75cfa6-89af-425b-bce5-2a85197ef04f",
    "name": "seinou-test-public",
    "status": "PENDING_UPDATE",
    "submask_length": 28,
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Delete Public Ip

Delete public_ip.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • DELETE

HTTP Request Path

{endpoint}/v2.0/public_ips/{public_ip_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
public_ip_id URI string hyph-uuid - Unique ID of the Public IPs 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.