Air APIAPI ReferenceInterfaces

List links

View as Markdown

List links that belong to simulations you have read access to. Results are paginated.

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

interfacestringOptionalformat: "uuid"

Lookup all links for a specific interface.

limitintegerOptional
Number of results to return per page.
nodestringOptionalformat: "uuid"

Lookup all links for a specific node.

offsetintegerOptional
The initial index from which to return the results.
orderingenumOptional

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

Allowed values:
searchstringOptional

Search by name or node_name.

simulationstringOptionalformat: "uuid"

Lookup all links for a specific simulation.

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