API reference
Endpoints, request fields, responses, authentication and validation.
Choose the service you are calling:
- crossfire: the server’s HTTP routes under
/api. - fleetd: the controller’s private HTTP API over a Unix socket, locally or through SSH.
Their catalog paths overlap because they are different services. Do not send a controller operation to the crossfire origin or expose the private socket through a public HTTP server.
Each operation page lists parameters, request and response fields, limits and validation functions. The functions include checks that cannot be expressed by a field table, such as dependencies between fields.
Matrix forwarding, signup, setup assets and public reports use different response formats. See other HTTP routes .
HTTP requests and responses
Authentication, response envelopes, errors, pagination, concurrency and request limits.
HTTP client examples
Call crossfire from JavaScript, TypeScript, C# or Rust, or query fleetd over its socket.
crossfire HTTP API
92 HTTP operations with request fields, responses and validation.
fleetd private API
19 HTTP operations with request fields, responses and validation.
Matrix operation catalog
157 Matrix HTTP operations with parameters and agent access classifications.
Other HTTP routes
Matrix, registration, setup assets, the web applications and public report reads.
Validation definitions
Types, constants and validation functions used by the HTTP operations.