Get virtual machine group

Return detailed information about a virtual machine group.


If successful, this endpoint will return a 200 OK status.


One of the following scopes are required to use this endpoint.


The following arguments are supported for this endpoint.

Name Type Default Value

virtual_machine_group Required

The virtual machine group to retrieve

Virtual Machine Group Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status


The authenticated identity is not permitted to perform this action

403 Forbidden


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
        created_at: Unix Timestamp