Skip to navigation

Expose several node ports as services

View as MarkdownOpen in Claude

Creates every service in services, or none: one refused entry refuses the request, and the error names the entries by position. At most 100 services per request, all in one simulation.

The rules of POST /api/v3/simulations/nodes/interfaces/services/ apply to each entry: an outbound interface with no link, and at most 252 services per interface. A simulation with Teleport on can hold at most 5000 services and VNC-enabled nodes combined.

Required scope: Simulation Edit (roles: Air Org Administrator, Air User)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
serviceslist of objectsRequired
Services to create. Every interface must belong to the same simulation. At most 100 services may be created per request.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
node_portinteger1-65535

The port number associated with the service within the allowable range for an IP port (UINT16).

worker_portinteger or nullRead-only
The port exposed by the worker.
worker_fqdnstring or nullRead-only
The FQDN of the worker machine this service is running on. When the associated node is not active, this will be null.
interfacestringformat: "uuid"
The outbound interface the service forwards to.
namestringOptional<=256 characters
The name of the service.
service_typeenumOptionalDefaults to OTHER

The type of service exposed (e.g. SSH or HTTP).

  • SSH - SSH
  • HTTPS - HTTPS
  • HTTP - HTTP
  • OTHER - Other
Allowed values:
teleport_access_portinteger or nullOptional1024-65535
The port that reaches this service over Teleport. Can only be set when the simulation's organization is allowed to use Teleport. When omitted, Air assigns one if Teleport is enabled on the simulation, and otherwise when Teleport is turned on.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error