API Reference

Katapult Core API

Resources & Endpoints

List virtual machine groups

Return a list of all virtual machine groups for an organization.

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

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

The organization to return groups for

 Organization Lookup None

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

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

Returned Object

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

{
    virtual_machine_groups: [ VirtualMachineGroup {
        id: String
        name: String
        segregate: Boolean
        created_at: Unix Timestamp
    } ]
}