Skip to main content
Use GET /facilities and GET /facilities/ to list and retrieve your NERC-registered facilities. Create, update, and delete operations are coming soon.
Facilities are the top-level structural objects in your Raptor Comply tenant. Each facility corresponds to a NERC-registered site - such as a substation, generating plant, or transmission station - that you’ve already classified inside the platform. Use these endpoints to read your facility inventory and integrate it into downstream tooling like CMDBs and asset management systems.
Every request to the Raptor Comply API requires the X-API-Key header. See Authentication for setup instructions.

Available endpoints

List all facilities

GET /facilities Returns an array of all facilities belonging to your organization. Use this endpoint to seed a downstream CMDB, build a facility picker in an internal tool, or audit the full list of sites registered in your Raptor Comply tenant.

Request

No path or query parameters are required. Include your authentication headers on every request.
curl --request GET \
  --url https://api.raptormaps.com/facilities \
  --header 'X-API-Key: YOUR_API_KEY'

Response

Returns 200 OK with a JSON array of facility objects.
id
string
Unique identifier for the facility, prefixed with fac_.
name
string
Human-readable name of the facility as configured in Raptor Comply.
[
  {
    "id": "fac_01HXY...",
    "name": "South Plant Substation",
    "organization_slug": "acme-utility"
  }
]

Get a single facility

GET /facilities/{id} Returns a single facility by its unique identifier. Use this endpoint when you need to look up or verify the details of a specific site - for example, after resolving a facility ID from a cyber system or cyber asset record.

Path parameters

id
string
required
The unique identifier of the facility, e.g. fac_01HXY.... You can obtain this value from the id field returned by GET /facilities.

Request

curl --request GET \
  --url https://api.raptormaps.com/facilities/fac_01HXY... \
  --header 'X-API-Key: YOUR_API_KEY'

Response

Returns 200 OK with a single facility object.
id
string
Unique identifier for the facility.
name
string
Human-readable name of the facility.
{
  "id": "fac_01HXY...",
  "name": "South Plant Substation",
  "organization_slug": "acme-utility"
}

Coming soon

The following endpoints exist in the Raptor Comply API but are not yet available via API-key authentication. They are documented here so you can plan your integrations in advance. Subscribe to release notes to be notified when each batch becomes available.
The endpoints below are coming soon and are not yet accessible with your API key. Requests to these paths will not succeed. Check back for updates.

Create a facility

POST /facilities Operation: createFacility - Creates a new facility in your Raptor Comply tenant.

Update a facility

PATCH /facilities/{id} Operation: updateFacility - Partially updates the properties of an existing facility.

Delete a facility

DELETE /facilities/{id} Operation: deleteFacility - Permanently removes a facility from your Raptor Comply tenant.