Allocate an IP address

POST 
/virtual_machine_network_interfaces/virtual_machine_network_interface/allocate_ip

Allocate a specific IP address to a given network interface

Scopes

• ip_addresses

OAuth2 Scopes

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

Request

application/json

Body

virtual_machine_network_interface

object

required

id string

ip_address

object

required

All 'ip_address[]' params are mutually exclusive, only one can be provided.

id string

address string

Responses

200

Allocate a specific IP address to a given network interface

application/json

Schema

Schema

virtual_machine_network_interface

object

required

id string

virtual_machine

object

id string

name string

name string

network

object

nullable

id string

name string

virtual_network

object

nullable

id string

name string

mac_address string

state string

ip_addresses

object[]

Array [

id string

address string

]

Example (from schema)

{
  "virtual_machine_network_interface": {
    "id": "string",
    "virtual_machine": {
      "id": "string",
      "name": "string"
    },
    "name": "string",
    "network": {
      "id": "string",
      "name": "string"
    },
    "virtual_network": {
      "id": "string",
      "name": "string"
    },
    "mac_address": "string",
    "state": "string",
    "ip_addresses": [
      {
        "id": "string",
        "address": "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

404 error response

application/json

Schema

Schema

oneOf

VirtualMachineNetworkInterfaceNotFoundSchema

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

code VirtualMachineNetworkInterfaceNotFoundEnum (string)

Possible values: [virtual_machine_network_interface_not_found]

description string

detail object

IPAddressNotFoundSchema

No IP addresses were found matching any of the criteria provided in the arguments

code IPAddressNotFoundEnum (string)

Possible values: [ip_address_not_found]

description string

detail object

Example (from schema)

{}

422

422 error response

application/json

Schema

Schema

oneOf

IPAlreadyAllocatedSchema

This IP address has already been allocated to another resource

code IPAlreadyAllocatedEnum (string)

Possible values: [ip_already_allocated]

description string

detail object

InvalidIPSchema

This IP address is not valid for this network interface.

code InvalidIPEnum (string)

Possible values: [invalid_ip]

description string

detail object

Example (from schema)

{}

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