Installation

Prerequisites

• Access to the Fleet cockpit for your workspace, with permission to create or rotate Platform API credentials.
• HTTPS from the environment where your integration runs.

Get a platform API key

1. Sign in to the Fleet cockpit.
2. Open the area where Platform API (or automation API) keys are managed.
3. Create a credential and copy the secret once. Store it in a secret manager or environment variable. Never commit it to source control.
4. Check the key’s scope: READ (read-only) or WRITE (required for creating or changing carts, users, devices, and for validating carts).

If a secret is exposed, rotate or revoke it from the same place.

Base URL

Environment	Host	Path prefix
Production	https://api.fleet.co	/platform/v1
Other (staging, sandbox)	https://demo-api.fleet.co	/platform/v1

First request

Use any GET operation from the API reference (for example list users or devices with limit=1). Send:

• Header Authorization: Bearer <your_secret>
• Query limit / offset when the operation supports pagination

A successful read returns 200 and JSON with a data object or array (plus meta for paginated lists). Invalid or revoked secrets typically return 401.

Explore the API

Use the API reference for exact paths, request bodies, and response shapes. Some builds also expose Markdown siblings for each operation (see this repo’s README for local generation).

Fleet also exposes hosted OpenAPI endpoints:

• Swagger UI: https://api.fleet.co/platform/v1/swagger
• OpenAPI JSON: https://api.fleet.co/platform/v1/openapi.json
• Sandbox / demo API: same paths on https://demo-api.fleet.co

You can import openapi.json directly into Postman, Insomnia, or code-generation tools.

Next steps

• Authentication & scopes — scopes and rate limits.
• Requests & responses — envelopes and errors.
• The resource guides for how catalog, carts, devices, and users fit together.