API Reference

Katapult Core API

Resources & Endpoints

Create console session

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

POST
https://api.katapult.io/core/v1/virtual_machines/{virtual_machine}/console_sessions

If successful, this endpoint will return a 201 Created status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

virtual_machine Required

VirtualMachine Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

object_in_trash

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.

 406 Not Acceptable

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

validation_error

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

 422 Unprocessable Entity

virtual_machine_must_be_started

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

 406 Not Acceptable

virtual_machine_not_found

No virtual machine was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    console_session: ConsoleSession {
        id: String
        url: String
        expires_at: Unix Timestamp
        virtual_machine: VirtualMachine {
            id: String
            name: String
            hostname: String
            fqdn: String
            state: VirtualMachineStateEnum
        }
    }
}