Build virtual machine (from spec)

POST 
https://api.katapult.io/core/v1/organizations/organization/virtual_machines/build_from_spec

Builds a new virtual machine by receiving a virtual machine spec document

Scopes

• virtual_machines

OAuth2 Scopes

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

Request

application/json

Body

organization

object

required

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

id string

sub_domain string
xml stringrequired

annotations

object[]

Array [

key stringrequired

value string

]

Responses

201

Builds a new virtual machine by receiving a virtual machine spec document

application/json

Schema

Schema

task

object

required

id string

name string

status TaskStatusEnum (string)

Possible values: [pending, running, completed, failed]

build

object

required

id string

state VirtualMachineBuildStateEnum (string)

Possible values: [draft, failed, pending, complete, building]

virtual_machine_build

object

required

id string

state VirtualMachineBuildStateEnum (string)

Possible values: [draft, failed, pending, complete, building]

hostname stringrequired

annotations

object[]

required

Array [

key stringrequired

value string

]

Example (from schema)

{
  "task": {
    "id": "string",
    "name": "string",
    "status": "pending"
  },
  "build": {
    "id": "string",
    "state": "draft"
  },
  "virtual_machine_build": {
    "id": "string",
    "state": "draft"
  },
  "hostname": "string",
  "annotations": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

400

400 error response

application/json

Schema

Schema

oneOf

APIAuthenticator400Schema

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

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string

detail object

InvalidSpecXMLSchema

The spec XML provided is invalid

code InvalidSpecXMLEnum (string)

Possible values: [invalid_spec_xml]

description string

detail

object

errors string

A textual description of the errors with the provided XML

Example (from schema)

{}

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[]

OrganizationSuspendedSchema

An organization was found from the arguments provided but it was suspended

code OrganizationSuspendedEnum (string)

Possible values: [organization_suspended]

description string

detail object

OrganizationNotActivatedSchema

An organization was found from the arguments provided but it wasn't activated yet

code OrganizationNotActivatedEnum (string)

Possible values: [organization_not_activated]

description string

detail object

PermissionDeniedSchema

The authenticated identity is not permitted to perform this action

code PermissionDeniedEnum (string)

Possible values: [permission_denied]

description string

detail

object

details stringnullable

Additional information regarding the reason why permission was denied

Example (from schema)

{}

404

No organization was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code OrganizationNotFoundEnum (string)

Possible values: [organization_not_found]

description string
detail object

Example (from schema)

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

422

A validation error occurred with the object that was being created/updated/deleted

application/json

Schema

Schema

code ValidationErrorEnum (string)

Possible values: [validation_error]

description string

detail

ValidationError

errors string[]

Example (from schema)

{
  "code": "validation_error",
  "description": "string",
  "detail": {
    "errors": [
      "string"
    ]
  }
}

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": {}
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.katapult.io/core/v1/organizations/organization/virtual_machines/build_from_spec' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "organization": {
    "id": "string",
    "sub_domain": "string"
  },
  "xml": "string",
  "annotations": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}'

Request Collapse all

Base URL

https://api.katapult.io/core/v1

Auth

Security Scheme

OAuth2Authenticator

Bearer Token

Body

{
  "organization": {
    "id": "string",
    "sub_domain": "string"
  },
  "xml": "string",
  "annotations": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!