https://api.katapult.io/core/v1/organizations/organization/virtual_machines/build_from_spec
| 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 |
|
|
invalid_spec_xml
|
The spec XML provided is invalid |
|
|
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 |
|
|
organization_suspended
|
An organization was found from the arguments provided but it was suspended |
|
|
organization_not_activated
|
An organization was found from the arguments provided but it wasn't activated yet |
|
|
permission_denied
|
The authenticated identity is not permitted to perform this action |
|
|
organization_not_found
|
No organization was found matching any of the criteria provided in the arguments |
|
|
validation_error
|
A validation error occurred with the object that was being created/updated/deleted |
|
|
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 |
organization
object
required
body
All 'organization[]' params are mutually exclusive, only one can be provided.
id
string
sub_domain
string
xml
string
required
body
annotations
array
body
key
string
value
string
task
object
id
string
name
string
status
string
build
Deprecated, please use "virtual_machine_build" instead
virtual_machine_build
object
id
string
state
string
hostname
string
annotations
array
key
string
value
string
{
"task": {
"id": "string",
"name": "string",
"status": "pending"
},
"build": "string",
"virtual_machine_build": {
"id": "string",
"state": "draft"
},
"hostname": "string",
"annotations": [
{
"key": "string",
"value": "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.