Skip to main content

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

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

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

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

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