Firezone — API
Firezone APIv1.0.0 Read the vendor's spec ↗
- 127 endpoints
- 4 deprecated
- 14 versions archived since Aug 12, 2026
- Last checked Nov 2, 2026
A REST API for configuring your Firezone account.
Get started
$ curl "/sites" \
-H "Authorization: Bearer $TOKEN"
Set $TOKEN first, then paste.
- Base URL
-
/ - Authenticate
- Bearer token in the Authorization header
What it covers
- Clients 7 read, update, delete
- Policies 7 create, read, update, delete
- Actors 6 create, read, update, delete
- Gateways 6 create, read, update, delete
- Groups 6 create, read, update, delete
- Resources 6 create, read, update, delete
- Sites 6 create, read, update, delete
- Client Tokens 5 create, read, delete
- Defender Posture Providers 5 read, update, delete
- Gateway Tokens 5 create, delete
- Intune Posture Providers 5 read, update, delete
- Iru Posture Providers 5 read, update, delete
24 more areas
- Santa Posture Providers 5 read, update, delete
- Sentinelone Posture Providers 5 read, update, delete
- Sophos Posture Providers 5 read, update, delete
- External Identities 3 read, delete
- Memberships 3 read, update
- Pool Members 3 read, update
- Defender Devices 2 read
- Email Otp Auth Providers 2 read
- Entra Auth Providers 2 read
- Entra Directories 2 read
- Github Auth Providers 2 read
- Google Auth Providers 2 read
- Google Directories 2 read
- Intune Devices 2 read
- Iru Devices 2 read
- Logs 2 read
- Oidc Auth Providers 2 read
- Okta Auth Providers 2 read
- Okta Directories 2 read
- Santa Devices 2 read
- Sentinelone Devices 2 read
- Sophos Devices 2 read
- Account 1 read
- X.509 Auth Providers 1 read
Open an endpoint for a runnable command, its inputs and what it returns.
endpoint surface across archived versions
endpoints at that version
added
removed
endpoint changes per archived version — drag across the rail to set a range
Clients 7
-
DELETE
/clients/{id}Delete a ClientLoading…
-
GET
/clientsList ClientsLoading…
-
GET
/clients/{id}Show ClientLoading…
-
PATCH
/clients/{id}Update ClientLoading…
-
PUT
/clients/{id}Update ClientLoading…
-
PUT
/clients/{id}/unverifyUnverify ClientLoading…
-
PUT
/clients/{id}/verifyVerify ClientLoading…
Policies 7
-
DELETE
/policies/{id}Delete a PolicyLoading…
-
GET
/policiesList PoliciesLoading…
-
GET
/policies/{id}Show PolicyLoading…
-
GET
/posture_fieldsList Posture FieldsLoading…
-
PATCH
/policies/{id}Update a PolicyLoading…
-
POST
/policiesCreate PolicyLoading…
-
PUT
/policies/{id}Update a PolicyLoading…
Actors 6
-
DELETE
/actors/{id}Delete an ActorLoading…
-
GET
/actorsList ActorsLoading…
-
GET
/actors/{id}Show ActorLoading…
-
PATCH
/actors/{id}Update an ActorLoading…
-
POST
/actorsCreate an ActorLoading…
-
PUT
/actors/{id}Update an ActorLoading…
Gateways 6
-
DELETE
/sites/{site_id}/gateways/{id}Delete a GatewayLoading…
-
GET
/sites/{site_id}/gatewaysList GatewaysLoading…
-
GET
/sites/{site_id}/gateways/{id}Show GatewayLoading…
-
PATCH
/sites/{site_id}/gateways/{id}Update a Gateway (rename)Loading…
-
POST
/sites/{site_id}/gatewaysProvision a GatewayLoading…
-
PUT
/sites/{site_id}/gateways/{id}Update a Gateway (rename)Loading…
Groups 6
-
DELETE
/groups/{id}Delete a GroupLoading…
-
GET
/groupsList GroupsLoading…
-
GET
/groups/{id}Show GroupLoading…
-
PATCH
/groups/{id}Update a GroupLoading…
-
POST
/groupsCreate GroupLoading…
-
PUT
/groups/{id}Update a GroupLoading…
Resources 6
-
DELETE
/resources/{id}Delete ResourceLoading…
-
GET
/resourcesList ResourcesLoading…
-
GET
/resources/{id}Show ResourceLoading…
-
PATCH
/resources/{id}Update ResourceLoading…
-
POST
/resourcesCreate ResourceLoading…
-
PUT
/resources/{id}Update ResourceLoading…
Sites 6
-
DELETE
/sites/{id}Delete a SiteLoading…
-
GET
/sitesList SitesLoading…
-
GET
/sites/{id}Show SiteLoading…
-
PATCH
/sites/{id}Update a SiteLoading…
-
POST
/sitesCreate SiteLoading…
-
PUT
/sites/{id}Update a SiteLoading…
Client Tokens 5
-
DELETE
/actors/{actor_id}/client_tokensDelete all Client Tokens for service_account, account_user, or account_admin_user actorsLoading…
-
DELETE
/actors/{actor_id}/client_tokens/{id}Delete a Client TokenLoading…
-
GET
/actors/{actor_id}/client_tokensList Client Tokens for service_account, account_user, or account_admin_user actorsLoading…
-
GET
/actors/{actor_id}/client_tokens/{id}Show a Client Token for service_account, account_user, or account_admin_user actorsLoading…
-
POST
/actors/{actor_id}/client_tokensCreate a Client Token for a Service AccountLoading…
Defender Posture Providers 5
-
DELETE
/defender_posture_providers/{id}Delete a Defender posture providerLoading…
-
GET
/defender_posture_providersList Defender posture providersLoading…
-
GET
/defender_posture_providers/{id}Show a Defender posture providerLoading…
-
PATCH
/defender_posture_providers/{id}Update a Defender posture providerLoading…
-
PUT
/defender_posture_providers/{id}Update a Defender posture providerLoading…
Gateway Tokens 5
-
DELETE
/sites/{site_id}/gateway_tokensDelete all Gateway Tokens for a SiteLoading…
-
DELETE
/sites/{site_id}/gateway_tokens/{id}Delete a Gateway TokenLoading…
-
POST
/sites/{site_id}/gateway_tokensCreate a Gateway Token deprecatedLoading…
-
POST
/sites/{site_id}/gateways/{gateway_id}/tokenCreate a single-owner Gateway TokenLoading…
-
POST
/sites/{site_id}/gateways/{gateway_id}/token/rotateRotate a single-owner Gateway TokenLoading…
Intune Posture Providers 5
-
DELETE
/intune_posture_providers/{id}Delete an Intune posture providerLoading…
-
GET
/intune_posture_providersList Intune posture providersLoading…
-
GET
/intune_posture_providers/{id}Show an Intune posture providerLoading…
-
PATCH
/intune_posture_providers/{id}Update an Intune posture providerLoading…
-
PUT
/intune_posture_providers/{id}Update an Intune posture providerLoading…
Iru Posture Providers 5
-
DELETE
/iru_posture_providers/{id}Delete an Iru posture providerLoading…
-
GET
/iru_posture_providersList Iru posture providersLoading…
-
GET
/iru_posture_providers/{id}Show an Iru posture providerLoading…
-
PATCH
/iru_posture_providers/{id}Update an Iru posture providerLoading…
-
PUT
/iru_posture_providers/{id}Update an Iru posture providerLoading…
Santa Posture Providers 5
-
DELETE
/santa_posture_providers/{id}Delete a Santa posture providerLoading…
-
GET
/santa_posture_providersList Santa posture providersLoading…
-
GET
/santa_posture_providers/{id}Show a Santa posture providerLoading…
-
PATCH
/santa_posture_providers/{id}Update a Santa posture providerLoading…
-
PUT
/santa_posture_providers/{id}Update a Santa posture providerLoading…
Sentinelone Posture Providers 5
-
DELETE
/sentinelone_posture_providers/{id}Delete a SentinelOne posture providerLoading…
-
GET
/sentinelone_posture_providersList SentinelOne posture providersLoading…
-
GET
/sentinelone_posture_providers/{id}Show a SentinelOne posture providerLoading…
-
PATCH
/sentinelone_posture_providers/{id}Update a SentinelOne posture providerLoading…
-
PUT
/sentinelone_posture_providers/{id}Update a SentinelOne posture providerLoading…
Sophos Posture Providers 5
-
DELETE
/sophos_posture_providers/{id}Delete a Sophos posture providerLoading…
-
GET
/sophos_posture_providersList Sophos posture providersLoading…
-
GET
/sophos_posture_providers/{id}Show a Sophos posture providerLoading…
-
PATCH
/sophos_posture_providers/{id}Update a Sophos posture providerLoading…
-
PUT
/sophos_posture_providers/{id}Update a Sophos posture providerLoading…
External Identities 3
-
DELETE
/actors/{actor_id}/external_identities/{id}Delete an External IdentityLoading…
-
GET
/actors/{actor_id}/external_identitiesList External Identities for an ActorLoading…
-
GET
/actors/{actor_id}/external_identities/{id}Show External IdentityLoading…
Memberships 3
-
GET
/groups/{group_id}/membershipsList MembershipsLoading…
-
PATCH
/groups/{group_id}/membershipsUpdate an MembershipLoading…
-
PUT
/groups/{group_id}/membershipsUpdate MembershipsLoading…
Pool Members 3
-
GET
/resources/{resource_id}/pool_membersList Pool Members deprecatedLoading…
-
PATCH
/resources/{resource_id}/pool_membersAdd or Remove Pool Members deprecatedLoading…
-
PUT
/resources/{resource_id}/pool_membersReplace Pool Members deprecatedLoading…
Defender Devices 2
-
GET
/defender_devicesList synced Defender devicesLoading…
-
GET
/defender_devices/{id}Show a synced Defender deviceLoading…
Email Otp Auth Providers 2
-
GET
/email_otp_auth_providersList Email OTP Auth ProvidersLoading…
-
GET
/email_otp_auth_providers/{id}Show Email OTP Auth ProviderLoading…
Entra Auth Providers 2
-
GET
/entra_auth_providersList Entra Auth ProvidersLoading…
-
GET
/entra_auth_providers/{id}Show Entra Auth ProviderLoading…
Entra Directories 2
-
GET
/entra_directoriesList Entra DirectoriesLoading…
-
GET
/entra_directories/{id}Show Entra DirectoryLoading…
Github Auth Providers 2
-
GET
/github_auth_providersList GitHub Auth ProvidersLoading…
-
GET
/github_auth_providers/{id}Show GitHub Auth ProviderLoading…
Google Auth Providers 2
-
GET
/google_auth_providersList Google Auth ProvidersLoading…
-
GET
/google_auth_providers/{id}Show Google Auth ProviderLoading…
Google Directories 2
-
GET
/google_directoriesList Google DirectoriesLoading…
-
GET
/google_directories/{id}Show Google DirectoryLoading…
Intune Devices 2
-
GET
/intune_devicesList synced Intune devicesLoading…
-
GET
/intune_devices/{id}Show a synced Intune deviceLoading…
Iru Devices 2
-
GET
/iru_devicesList synced Iru devicesLoading…
-
GET
/iru_devices/{id}Show a synced Iru deviceLoading…
Logs 2
-
GET
/logsList LogsLoading…
-
GET
/logs/{log_id}Show LogLoading…
Oidc Auth Providers 2
-
GET
/oidc_auth_providersList OIDC Auth ProvidersLoading…
-
GET
/oidc_auth_providers/{id}Show OIDC Auth ProviderLoading…
Okta Auth Providers 2
-
GET
/okta_auth_providersList Okta Auth ProvidersLoading…
-
GET
/okta_auth_providers/{id}Show Okta Auth ProviderLoading…
Okta Directories 2
-
GET
/okta_directoriesList Okta DirectoriesLoading…
-
GET
/okta_directories/{id}Show Okta DirectoryLoading…
Santa Devices 2
-
GET
/santa_devicesList synced Santa devicesLoading…
-
GET
/santa_devices/{id}Show a synced Santa deviceLoading…
Sentinelone Devices 2
-
GET
/sentinelone_devicesList synced SentinelOne devicesLoading…
-
GET
/sentinelone_devices/{sentinelone_agent}Show a synced SentinelOne deviceLoading…
Sophos Devices 2
-
GET
/sophos_devicesList synced Sophos devicesLoading…
-
GET
/sophos_devices/{id}Show a synced Sophos deviceLoading…
Account 1
-
GET
/accountShow AccountLoading…
X.509 Auth Providers 1
-
GET
/x509_auth_providerShow X.509 Auth ProviderLoading…
No endpoint matches. Clear the filter to see all 127.
Change log
-
- +DELETE /defender_posture_providers/{id}
- +DELETE /intune_posture_providers/{id}
- +DELETE /iru_posture_providers/{id}
- +DELETE /santa_posture_providers/{id}
- +DELETE /sentinelone_posture_providers/{id}
- +DELETE /sophos_posture_providers/{id}
- +GET /posture_fields
- +PATCH /defender_posture_providers/{id}
- +PATCH /intune_posture_providers/{id}
- +PATCH /iru_posture_providers/{id}
- +PATCH /santa_posture_providers/{id}
- +PATCH /sentinelone_posture_providers/{id}
- +PATCH /sophos_posture_providers/{id}
- +PUT /defender_posture_providers/{id}
- +PUT /intune_posture_providers/{id}
- +PUT /iru_posture_providers/{id}
- +PUT /santa_posture_providers/{id}
- +PUT /sentinelone_posture_providers/{id}
- +PUT /sophos_posture_providers/{id}
-
- +GET /github_auth_providers
- +GET /github_auth_providers/{id}
- +GET /sophos_devices
- +GET /sophos_devices/{id}
- +GET /sophos_posture_providers
- +GET /sophos_posture_providers/{id}
-
- ⚠GET /resources/{resource_id}/pool_members
- ⚠PATCH /resources/{resource_id}/pool_members
- ⚠PUT /resources/{resource_id}/pool_members
-
- +GET /defender_devices
- +GET /defender_devices/{id}
- +GET /defender_posture_providers
- +GET /defender_posture_providers/{id}
- +GET /santa_devices
- +GET /santa_devices/{id}
- +GET /santa_posture_providers
- +GET /santa_posture_providers/{id}
- +GET /sentinelone_devices
- +GET /sentinelone_devices/{sentinelone_agent}
- +GET /sentinelone_posture_providers
- +GET /sentinelone_posture_providers/{id}
- +GET /x509_auth_provider
-
- +GET /intune_posture_providers
- +GET /intune_posture_providers/{id}
- +GET /iru_devices
- +GET /iru_devices/{id}
- +GET /iru_posture_providers
- +GET /iru_posture_providers/{id}
- −GET /intune_integration
-
- +GET /intune_devices
- +GET /intune_devices/{id}
- +GET /intune_integration
- +GET /resources/{resource_id}/pool_members
- +PATCH /resources/{resource_id}/pool_members
- +PATCH /sites/{site_id}/gateways/{id}
- +POST /sites/{site_id}/gateways
- +PUT /resources/{resource_id}/pool_members
- +PUT /sites/{site_id}/gateways/{id}