API Reference

Katapult Core API

Resources & Endpoints

Get virtual machine package

Return information about a given virtual machine package.

GET
https://api.katapult.io/core/v1/virtual_machine_packages/{virtual_machine_package}

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_package Required

Virtual Machine Package Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

package_not_found

No package 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_package: VirtualMachinePackage {
        id: String
        name: String
        permalink: String
        cpu_cores: Integer
        ipv4_addresses: Integer
        memory_in_gb: Integer
        storage_in_gb: Integer
        monthly_bandwidth_allowance_in_gb: Integer?
        privacy: PrivacyTypesEnum
        icon: Attachment? {
            url: String
            file_name: String
            file_type: String
            file_size: Integer
            digest: String
            token: String
        }
    }
}