API Reference

Katapult Core API

Resources & Endpoints

List virtual machines

Returns a list of all virtual machines for a given organization.

GET
https://api.katapult.io/core/v1/organizations/{organization}/virtual_machines

If successful, this endpoint will return a 200 OK 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

organization Required

Organization Lookup None

annotations

An array of annotations to filter by

 KeyValue Array None

page

Integer 1

per_page

Integer 30

Potential Errors

The following errors may occur during this request.

Details HTTP status

organization_not_activated

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

 403 Forbidden

organization_not_found

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

 404 Not Found

organization_suspended

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

 403 Forbidden

Returned Object

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

{
    pagination: Pagination Details {
        current_page: Integer
        total_pages: Integer?
        total: Integer?
        per_page: Integer
        large_set: Boolean
    }
    virtual_machines: [ VirtualMachine {
        id: String
        name: String
        hostname: String
        fqdn: String
        created_at: Unix Timestamp
        zone: Zone {
            id: String
            name: String
            permalink: String?
            data_center: DataCenter {
                id: String
                name: String
                permalink: String
            }
        }
        package: VirtualMachinePackage? {
            name: String
        }
        gpu_type: GPUType? {
            id: String
            name: String
            permalink: String
        }
        ip_addresses: [ IPAddress {
            address: String
        } ]
    } ]
}