Get virtual machine build

GET 
/virtual_machines/builds/virtual_machine_build

Return virtual machine build information

Scopes

• virtual_machines
• virtual_machines:read

OAuth2 Scopes

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

Request

Query Parameters

virtual_machine_build[id] string

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

Responses

200

Return virtual machine build information

application/json

Schema

Schema

virtual_machine_build

object

required

id string

spec_xml string

state VirtualMachineBuildStateEnum (string)

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

virtual_machine

object

nullable

id string

name string

hostname string

fqdn string

state VirtualMachineStateEnum (string)

Possible values: [stopped, failed, started, starting, allocated, allocating, resetting, migrating, stopping, shutting_down, transferring, orphaned]

created_at integer

annotations

object[]

required

Array [

key stringrequired

value string

]

Example (from schema)

{
  "virtual_machine_build": {
    "id": "string",
    "spec_xml": "string",
    "state": "draft",
    "virtual_machine": {
      "id": "string",
      "name": "string",
      "hostname": "string",
      "fqdn": "string",
      "state": "stopped"
    },
    "created_at": 0
  },
  "annotations": [
    {
      "key": "string",
      "value": "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

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

application/json

Schema

Schema

code VirtualMachineBuildNotFoundEnum (string)

Possible values: [build_not_found]

description string
detail object

Example (from schema)

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

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