Air APIAPI ReferenceWorkers

Create a worker

View as Markdown

Creates a worker instance and returns a registration token. This token is tied to the resulting worker and should be provided to the Air Worker daemon running on the target host in order to complete the registration. Registration token is valid for 1 day, 0:00:00.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
fqdnstringRequired1-255 characters
ip_addressstringRequired>=1 character
fleetstringRequiredformat: "uuid"
The fleet that the worker belongs to.
cpu_archenumOptional
  • x86 - x86
  • ARM - ARM
flagsobjectOptional
Behavior flags for the worker.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
fqdnstring<=255 characters
cpuintegerRead-only
memoryintegerRead-only
storageintegerRead-only
availablebooleanRead-only
ip_addressstring
fleetstringformat: "uuid"
The fleet that the worker belongs to.
registration_tokenstringRead-only

Token to be used during worker registration. Token is valid for 1 day, 0:00:00.

cpu_archenumOptional
  • x86 - x86
  • ARM - ARM
flagsobjectOptional
Behavior flags for the worker.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error