Air APIAPI ReferenceInterfaces

Create a link

View as Markdown

Create a new link between two interfaces in a simulation. This operation is not permitted if the simulation is not in an updatable state.

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

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
interfaceslist of stringsRequired
Two interfaces to connect. Both interfaces must be part of the same simulation.
labelsobject or nullOptional

Labels/properties of the link, such as cable_length.

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

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error