Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onefirewall.com/llms.txt

Use this file to discover all available pages before exploring further.

To use these APIs you will need to have authorized access to the OneFirewall platform. If you don’t already have, create and account and login into the application OneFirewall Alliance Platform

​
Generate a API Token

Once you have access to the OneFirewall Platform, you have to navigate under the profile page, where you can click and generate an API JWT Token that you have to store and use it for the requests to the set of APIs as presented in this documentation. On every request to the APIs you must use your own key within the authorization header. An example of a simple API againt /api/v1/version can be found below (even if this API does not require authorization)
HTTP Request
GET /api/v1/version HTTP/1.1
Host: app.onefirewall.com
Authorization: Bearer PLACE_YOUR_OWN_TOKEN_HERE
Python Request
simple-http-request.py
import requests

url = "https://app.onefirewall.com/api/v1/version"

payload={}
headers = {
  'Authorization': 'Bearer PLACE_YOUR_OWN_TOKEN_HERE'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

​
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:
  1. Header: Include the X-Org-Id header with your organization’s ID.
  2. Query Parameter: Include org_id=YOUR_ORG_ID in the URL.
If neither is provided, the API will fall back to your default/current organization if applicable, or return an error if the context cannot be determined.
Example with Org ID Header
POST /api/v1/scan/example.com HTTP/1.1
Host: app.onefirewall.com
Authorization: Bearer YOUR_TOKEN
X-Org-Id: 69084dbb6b1a388fbd6c757d