API Reference

Katapult Core API

Resources & Endpoints

Get virtual machine build

Return virtual machine build information.

GET
https://api.katapult.io/core/v1/virtual_machines/builds/{virtual_machine_build}

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

virtual_machine_build

Virtual Machine Build Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

build_not_found

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

{
    virtual_machine_build: VirtualMachineBuild {
        id: String
        spec_xml: String
        state: VirtualMachineBuildStateEnum
        virtual_machine: VirtualMachine? {
            id: String
            name: String
            hostname: String
            fqdn: String
            state: VirtualMachineStateEnum
        }
        created_at: Unix Timestamp
    }
    annotations: [ KeyValue {
        key: String
        value: String?
    } ]
}