Air APIAPI ReferenceSimulations

List visible simulations

View as Markdown

List simulations visible to your account.

Required scope: air:simulation_read (roles: air_org_admin, air_user)

Alternative: role air_trainee also grants access.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

auto_oob_enabledbooleanOptional
creatorstringOptional
The email of the user who created the simulation.
enable_dhcpbooleanOptional
idstringOptionalformat: "uuid"
limitintegerOptional
Number of results to return per page.
namestringOptional
offsetintegerOptional
The initial index from which to return the results.
orderingenumOptional

Order objects by field. Prefix with - for descending order.

searchstringOptional

Search by name, id, assigned_to, or creator.

stateenumOptional
* `CLONING` - Cloning * `CREATING` - Creating * `IMPORTING` - Importing * `INVALID` - Invalid * `INACTIVE` - Inactive * `REQUESTING` - Requesting * `PENDING` - Pending * `PROVISIONING` - Provisioning * `PREPARE_BOOT` - Prepare to boot * `BOOTING` - Booting * `ACTIVE` - Active * `PREPARE_SHUTDOWN` - Prepare to shutdown * `SHUTTING_DOWN` - Shutting down * `SAVING` - Saving * `DELETING` - Deleting * `PREPARE_PURGE` - Prepare to purge * `PURGING` - Purging * `DEMO` - Demo * `TRAINING` - Training * `PREPARE_REBUILD` - Prepare to rebuild * `REBUILDING` - Rebuilding * `ADMIN_SUSPENDED` - Admin suspended

Response

countinteger
resultslist of objects
nextstring or nullOptionalformat: "uri"
previousstring or nullOptionalformat: "uri"

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error