Skip to main content
Updated API documentation with live interaction is now available in the product dashboard under API Docs.
To use these APIs, you need authorized access to the OneFirewall platform. If you don’t have an account, create one and log in at the OneFirewall Alliance Platform.

​
Generate an API Token

Once you have access, go to the profile page and generate an API JWT token. Store it securely — you’ll need it for every request to the APIs described in this documentation. Every request must include your token in the Authorization header. The example below targets /api/v1/version, an endpoint that doesn’t actually require authorization.
HTTP Request
Python Request
simple-http-request.py

​
Organization Selection

For certain APIs, especially those related to scanning and resource management, you must specify the organization context. You can do this in two ways:
  • Header: X-Org-Id set to your organization’s ID.
  • Query parameter: org_id=YOUR_ORG_ID appended to the URL.
If neither is provided, the API falls back to your default organization, or returns an error if no context can be determined.
Example with Org ID Header