API Reference

Katapult Core API

Resources & Endpoints

Update a virtual machine group

Update a virtual machine group with the provided details.

PATCH
https://api.katapult.io/core/v1/virtual_machine_groups/{virtual_machine_group}

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

The virtual machine group to update

 Virtual Machine Group Lookup None

properties Required

The new details for the group

 VirtualMachineGroupArguments None

Potential Errors

The following errors may occur during this request.

Details HTTP status

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_group_not_found

No virtual machine group 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_group: VirtualMachineGroup {
        id: String
        name: String
        segregate: Boolean
        auto_segregate: Boolean
        created_at: Unix Timestamp
    }
}