Skip to main content

List of Virtual Labs​

Select

SaaS
Customer Managed

Get List of Virtual Labs

Responses

OK

Schema
  • labs object[]
  • name string

    Name of virtual lab

  • id int32

    lab id

  • state VMState

    Possible values: [STOPPED = 0, RUNNING = 1, SUSPENDED = 2, UNKNOWN = 3, ARCHIVED = 4, EXPIRED = 5, UNAVAILABLE = 6, CREATING = 101, CLONING = 102, CREATING_SNAPSHOT = 103, REVERTING_SNAPSHOT = 104, DELETING_SNAPSHOT = 105, STARTING = 106, STOPPING = 107, SUSPENDING = 108, RESTARTING = 109, DELETING = 110, RECOVERING = 111, RETRIEVING = 112]

    State of VirtualMachine

  • vmCount int32

    Number of virtual machines present in virtual lab

  • target object
  • id int32
  • name string
  • expirationTime int32

    Expiration time of virtual lab

  • jobInfo object

    Job summary of lab under creation

  • id int64

    Job id

  • progress float

    Job progress in percentage

  • operationType VMOperationEnum

    Possible values: [CREATE = 0, RESTART = 1, SHUTDOWN = 2, SNAPSHOT = 3, RESTORE_SNAP = 4, DELETE = 5, CLONE = 6, PAUSE = 7, POWERON = 10, EDIT = 11, VIEW_SNAPSHOTS = 12, DELETE_SNAP_VM = 15, RENEW_VM = 17, REFRESH_VM = 20, EDIT_OWNERS = 21, POWER_OFF = 29, EDIT_CREATOR = 30, REFRESH = 31, LIST_OWNERS = 32, CREATE_LAB = 34]

GET /v4/virtuallabs

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/VirtualLabs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'