Create console session

POST 
/virtual_machines/virtual_machine/console_sessions

Creates a new console session which can be opened in a browser

Scopes

• virtual_machines
• virtual_machines:console

OAuth2 Scopes

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

Request

application/json

Body

virtual_machine

object

required

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

id string

fqdn string

Responses

201

Creates a new console session which can be opened in a browser

application/json

Schema

Schema

console_session

object

required

id string

url string

expires_at integer

virtual_machine

object

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]

Example (from schema)

{
  "console_session": {
    "id": "string",
    "url": "string",
    "expires_at": 0,
    "virtual_machine": {
      "id": "string",
      "name": "string",
      "hostname": "string",
      "fqdn": "string",
      "state": "stopped"
    }
  }
}

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

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 virtual machine was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code VirtualMachineNotFoundEnum (string)

Possible values: [virtual_machine_not_found]

description string
detail object

Example (from schema)

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

406

406 error response

application/json

Schema

Schema

oneOf

ObjectInTrashSchema

The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation.

code ObjectInTrashEnum (string)

Possible values: [object_in_trash]

description string

detail

object

trash_object

object

nullable

id string

keep_until integer

object_id string

object_type string

VirtualMachineMustBeStartedSchema

Virtual machines must be in a started state to create console sessions

code VirtualMachineMustBeStartedEnum (string)

Possible values: [virtual_machine_must_be_started]

description string

detail

object

current_state string

Example (from schema)

{}

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

Loading...