Reserved addresses

This page describes operations you can perform on reserve_addresses. List, and get details for.

List Reserve Address

List all visible reserve_addresses.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/reserve_addresses

HTTP Request Parameters

Parameter

Style

Type

Format

Enumeration

Description

Required

id

query

string

hyph-uuid

-

Id which should be equal to tenant_id.

no

tenant_id

query

string

-

-

The owner of reserve_addresses.

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

reserve_addresses

array<object>

Reserved addresses

-

id

string

hyph-uuid

Id which should be equal to tenant_id.

subnets

array<string>

-

Reserved CIDR of a subnet.

tenant_id

string

-

The owner of reserve_addresses.

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.

{
  "reserve_addresses": [
    {
      "id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "subnets": [
        "169.254.0.0/16"
      ],
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Show Reserve Address

Show details for reserve_address.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/reserve_addresses/{reserve_address_id}

HTTP Request Parameters

Parameter

Style

Type

Format

Enumeration

Description

Required

reserve_address_id

URI

string

hyph-uuid

-

Id which should be equal to tenant_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

reserve_address

object

Reserved addresses

-

id

string

hyph-uuid

Id which should be equal to tenant_id.

subnets

array<string>

-

Reserved CIDR of a subnet.

tenant_id

string

-

The owner of reserve_addresses.

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "reserve_address": {
    "id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "subnets": [
      "169.254.0.0/16"
    ],
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}