Get addresses available for network interface

GET 
/virtual_machine_network_interfaces/virtual_machine_network_interface/available_ips/address_version

Returns a list of IP addresses that can be allocated to a specific network interface

Scopes

• ip_addresses
• ip_addresses:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

virtual_machine_network_interface[id] string

The network interface to get IP addresses for.

address_version IPAddressVersionEnumrequired

Possible values: [ipv4, ipv6]

The IP address version to return results for

Responses

200

Returns a list of IP addresses that can be allocated to a specific network interface

application/json

Schema

Schema

ip_addresses

object[]

required

The IP addresses available for this network interface

Array [

id string

address string

reverse_dns string

vip boolean

label stringnullable

address_with_mask string

network

object

id string

name string

permalink stringnullable

data_center

object

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

allocation_id stringnullable

allocation_type stringnullable

]

Example (from schema)

{
  "ip_addresses": [
    {
      "id": "string",
      "address": "string",
      "reverse_dns": "string",
      "vip": true,
      "label": "string",
      "address_with_mask": "string",
      "network": {
        "id": "string",
        "name": "string",
        "permalink": "string",
        "data_center": {
          "id": "string",
          "name": "string",
          "permalink": "string",
          "country": {
            "id": "string",
            "name": "string",
            "iso_code2": "string",
            "iso_code3": "string",
            "time_zone": "string",
            "eu": true
          }
        }
      },
      "allocation_id": "string",
      "allocation_type": "string"
    }
  ]
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

Example (from schema)

{}

404

No network interface was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code VirtualMachineNetworkInterfaceNotFoundEnum (string)

Possible values: [virtual_machine_network_interface_not_found]

description string
detail object

Example (from schema)

{
  "code": "virtual_machine_network_interface_not_found",
  "description": "string",
  "detail": {}
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...