Air APIAPI ReferenceInterfaces

Retrieve a link

View as Markdown

Retrieve a link.

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.

Path parameters

idstringRequiredformat: "uuid"
A UUID string identifying this link.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
interfaceslist of objectsRead-only
The two interfaces connected by this link.
labelsobject or nullOptional

Labels/properties of the link, such as cable_length.

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error