https://api.katapult.io/core/v1/virtual_machine_network_interfaces/virtual_machine_network_interface/allocate_new_ip
| Code | Error | When it happens |
|---|---|---|
|
|
missing_api_token
|
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer |
|
|
unauthorized_network_for_api_token
|
Network is not allowed to access the API with this API token |
|
|
invalid_api_token
|
The API token provided was not valid (it may not exist or have expired) |
|
|
token_owner_suspended
|
The user that owns the API token has been suspended |
|
|
invalid_capabilities_token
|
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key) |
|
|
scope_not_granted
|
The scope required for this endpoint has not been granted to the authenticating identity |
|
|
virtual_machine_suspended
|
A virtual machine was found from the arguments provided but it is suspended |
|
|
permission_denied
|
The authenticated identity is not permitted to perform this action |
|
|
virtual_machine_network_interface_not_found
|
No network interface was found matching any of the criteria provided in the arguments |
|
|
rate_limit_reached
|
You have reached the rate limit for this type of request |
|
|
service_unavailable
|
The service is currently unavailable, please try again later |
|
|
no_available_addresses
|
Our pool of addresses for that version seems to have run dry. If this issue continues, please contact support. |
virtual_machine_network_interface
object
required
body
id
string
address_version
string
required
body
ip_address
The newly allocated IP address
{
"ip_address": "string"
}Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.
Pre-filled with the endpoint's shape — declared defaults where it has them, otherwise a placeholder per type. Edit it before executing; the Arguments tab documents every field.