Air APIAPI ReferenceServices

Create a service

View as Markdown

Create a service such as an SSH or HTTP service on the outbound interface of a node. Services can only be added to outbound interfaces without a connection. There can be at most 252 services on any individual interface.

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.
node_portintegerRequired1-65535

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

interfacestringRequiredformat: "uuid"
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

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"
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

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error