Getting Started with the FORT API

Welcome to the FORT API! This guide will walk you through the essential steps to start managing your FORT Robotics configurations, devices, and users programmatically.

Step 1: Create an API Key

First, you'll need to generate an API key from the FORT Manager web application.

Log in to the FORT Manager web app.
Navigate to the API Key Management page in your settings.
Click Create.
Give your key a description and assign it the necessary roles to define its permissions.

When you create a key, a corresponding service account user is also created. This user is referenced in logs and audit trails for any actions performed by the key.

Step 2: Copy Your Key

After creating the key, you will be shown the key value. Copy this key immediately and store it in a secure location.

Step 3: Authenticate and Make API Calls

To authenticate your requests, include the API key in the Authorization header of your HTTP request, prefixed with Bearer.

All API requests should be made to the base URL:

Base URL

https://platform.fortrobotics.com

Here is an example of how to make an authenticated request using cURL:

Code

curl --request GET \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations \
  --header 'Authorization: Bearer [YOUR_API_KEY]' \
  --header 'Content-Type: application/json'

Replace [YOUR_API_KEY] with the key you copied in the previous step. You're now ready to start making calls to the FORT API!

Replace :orgId with your Org Id, which can be found by clicking your profile icon in the top right corner of FORT Manager and selecting Copy Org ID.

Next Steps

Now that you're set up, you can explore what's possible:

Head over to the Examples page to see tutorials for common network setups.
For a complete reference of all available endpoints and data models, see the API v1 Reference.