List services

View as Markdown

List services 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

idstringOptionalformat: "uuid"
interfacestringOptionalformat: "uuid"
limitintegerOptional
Number of results to return per page.
namestringOptional
nodestringOptionalformat: "uuid"
node_portintegerOptional
offsetintegerOptional
The initial index from which to return the results.
orderingenumOptional

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

searchstringOptional

Search by name, service_type, node_port, worker_fqdn, or worker_port.

service_typeenumOptional
The type of service exposed (e.g. SSH or HTTP). * `SSH` - SSH * `HTTPS` - HTTPS * `HTTP` - HTTP * `OTHER` - Other
Allowed values:
simulationstringOptionalformat: "uuid"
worker_fqdnstringOptional
worker_portintegerOptional

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