Source
API documentation — Fleet
Checked for Fleet on 6 Nov 2026
- Page
- https://fleetdm.com/docs/api/rest-api
- Checked
- 6 Nov 2026, 04:49 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:415766e47c4f7d702e3f8d6b915fcc3984e3a2cec047162d105783da20ab288d
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
Rest API purpose Report an error
“Use the Fleet APIs to automate Fleet. This page includes a list of available resources and their API routes.”
-
Request body limit Report an error
“Unless otherwise specified, endpoints that accept a request body limit its size to the configured FLEET_SERVER_DEFAULT_MAX_REQUEST_BODY_SIZE (default 1MiB).”
-
Token authentication Report an error
“All API requests to the Fleet server require API token authentication unless noted in the documentation. API tokens are tied to your Fleet user account.”
-
Token retrieval Report an error
“To get an API token, retrieve it from "My account" > "Get API token" in the Fleet UI (/profile). Or, you can send a request to the login API endpoint to get your token.”
-
SSO MFA API login disabled Report an error
“For SSO and MFA users, email/password login is disabled. The API token can instead be retrieved from the "My account" page in the UI (/profile).”
-
Session token default expiry Report an error
“The token_expires_at field shows when the token expires, based on the Fleet server's session duration setting (default: 5 days).”
-
API only token no expiry Report an error
“For API-only users, token expiration isn't enforced. The response still includes token_expires_at, but the token remains valid after that time.”
-
Rate limiting Report an error
“Status: 429 Too Many Requests Header: retry-after: N This response includes a header retry-after that indicates how many more seconds you are blocked before you can try again.”
-
Forgot password smtp required Report an error
“Sends a password reset email to the specified email. Requires that SMTP or SES is configured for your Fleet server.”
-
SSO callback cookie Report an error
“A successful response contains an HTTP cookie __Host-FLEETSSOSESSIONID that needs to be sent on the POST /api/v1/fleet/sso/callback request (this HTTP cookie is used to identify the SSO login session).”
-
Activities pagination max Report an error
“per_page integer query Results per page. Maximum is 10,000 records. If no pagination parameters are specified, defaults to 10,000.”
-
Ca supported providers Report an error
“Fleet currently supports DigiCert, Okta, Microsoft NDES, Hydrant, Smallstep, and any custom SCEP or EST CA.”
-
Certificate templates android scep Report an error
“Fleet currently supports adding certificates for Android that are issued from a custom SCEP certificate authority.”
-
Fleet ID param premium Report an error
“fleet_id string body Available in Fleet Premium. The ID of the fleet to add profiles to.”
-
Node key auth certificates Report an error
“This endpoint accepts the node key from Fleet's Android agent for authentication in addition to default authentication with a Bearer token.”
-
Request certificate supported cas Report an error
“Currently, this endpoint is only supported for Hydrant, custom EST, and NDES and Okta (Okta uses NDES under the hood) CAs. Google CA coming soon”
-
Request certificate premium Report an error
“Available in Fleet Premium. IdP credentials are only accepted for an introspection endpoint listed in integrations.certificates_idp_introspection_urls.”
-
Http signature auth Report an error
“As an alternative to API token authentication, you can send an HTTP signature in the request header. A request authenticated this way must name the end user Fleet has recorded for that host. Hosts with no recorded end user are rejected.”
-
Resend certificate android only Report an error
“Resends a certificate for the specified host. Currently, only Android certificates are supported.”
-
Charts metrics Report an error
“The available metrics are: uptime: the number of hosts online (checking in to Fleet) during each bucket. cve: Available in Fleet Premium. The number of hosts with vulnerabilities in tracked software during each bucket.”
-
Charts days range Report an error
“days integer query Number of days of history to return. Must be between 1 and 31. Default is 7.”
-
Conditional access okta Report an error
“Download the SAML IdP signing certificate for Okta conditional access. Okta uses this certificate to verify SAML assertions signed by Fleet.”
-
Conditional access entra delete Report an error
“Delete Microsoft Entra ID”
-
Audit logs API Report an error
“Returns a list of the activities that have been performed in Fleet. For a comprehensive list of activity types and detailed information, please see the audit logs page. GET /api/v1/fleet/activities”
-
Policy automation activities endpoint Report an error
“GET /api/v1/fleet/policies/:id/automation_activities”
-
SCIM section Report an error
“SCIM”
-
Software self service categories section Report an error
“Self-service categories”
-
Translator section Report an error
“Translator”
-
Custom host vitals section Report an error
“Custom host vitals”
1 fact read from this page is not shown because it could not be confirmed on the page as captured.
Scores citing this record
- The Mac Fleet Administrator Configuration, apps & updates
- The Mac Fleet Administrator Directory, API & administration
- The Field Operations Lead Configuration, apps & updates
- The Field Operations Lead Directory, API & administration
- The Solo IT Administrator Directory, API & administration
- The MSP Technician Configuration, apps & updates
- The MSP Technician Directory, API & administration
- The Information Security Officer Configuration, apps & updates
- The Information Security Officer Directory, API & administration
- The Skeptic Configuration, apps & updates
- The Skeptic Directory, API & administration