> ## Documentation Index
> Fetch the complete documentation index at: https://docs.raptorcomply.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cyber Systems

> Use GET /cyber-systems and GET /cyber-systems/{id} to read your BES Cyber Systems. Filtering by facility or control center is coming soon.

> Use GET /cyber-systems and GET /cyber-systems/{id} to read your BES Cyber Systems. Filtering by facility or control center is coming soon.

BES Cyber Systems (BCS) are the logical groupings of cyber assets that perform or support a reliable operation of the Bulk Electric System. In Raptor Comply, each cyber system is scoped to a facility or control center and carries an impact rating (High, Medium, or Low) that drives your CIP requirements. Use these endpoints to read your cyber system inventory and link it to asset management or SIEM workflows.

<Note>
  Every request to the Raptor Comply API requires the **X-API-Key** header. See [Authentication](/authentication) for setup instructions.
</Note>

***

## Available endpoints

### List all cyber systems

<span style={{ background: '#22c55e', color: '#fff', borderRadius: '4px', padding: '2px 8px', fontWeight: 700, fontSize: '0.8rem', marginRight: '8px' }}>GET</span> `/cyber-systems`

Returns an array of all BES Cyber Systems belonging to your organization. Use this endpoint to load your full BCS inventory - for example, to pre-populate a system picker, reconcile against a CMDB, or feed a compliance dashboard.

#### Request

No path or query parameters are required. Include your authentication headers on every request.

```bash theme={null} theme={null}
curl --request GET \
  --url https://api.raptormaps.com/cyber-systems \
  --header 'X-API-Key: YOUR_API_KEY'
```

#### Response

Returns `200 OK` with a JSON array of cyber system objects.

<ResponseField name="id" type="string">
  Unique identifier for the cyber system, prefixed with `cs_`.
</ResponseField>

<ResponseField name="name" type="string">
  Human-readable name of the cyber system as configured in Raptor Comply, e.g. `EMS BCS High`.
</ResponseField>

<ResponseField name="facility_id" type="string">
  The unique identifier of the facility this cyber system belongs to. Use `GET /facilities/{id}` to look up facility details.
</ResponseField>

<ResponseField name="organization_slug" type="string">
  The slug of the organization that owns this cyber system.
</ResponseField>

```json theme={null} theme={null}
[
  {
    "id": "cs_01DEF...",
    "name": "EMS BCS High",
    "facility_id": "fac_01HXY...",
    "organization_slug": "acme-utility"
  }
]
```

***

### Get a single cyber system

<span style={{ background: '#22c55e', color: '#fff', borderRadius: '4px', padding: '2px 8px', fontWeight: 700, fontSize: '0.8rem', marginRight: '8px' }}>GET</span> `/cyber-systems/{id}`

Returns a single BES Cyber System by its unique identifier. Use this endpoint to resolve a specific BCS - for example, after finding a `cyber_system_id` on a cyber asset record and needing the full system context.

#### Path parameters

<ParamField path="id" type="string" required>
  The unique identifier of the cyber system, e.g. `cs_01DEF...`. You can obtain this value from the `id` field returned by `GET /cyber-systems`.
</ParamField>

#### Request

```bash theme={null} theme={null}
curl --request GET \
  --url https://api.raptormaps.com/cyber-systems/cs_01DEF... \
  --header 'X-API-Key: YOUR_API_KEY'
```

#### Response

Returns `200 OK` with a single cyber system object.

<ResponseField name="id" type="string">
  Unique identifier for the cyber system.
</ResponseField>

<ResponseField name="name" type="string">
  Human-readable name of the cyber system.
</ResponseField>

<ResponseField name="facility_id" type="string">
  The unique identifier of the facility this cyber system belongs to.
</ResponseField>

<ResponseField name="organization_slug" type="string">
  The slug of the organization that owns this cyber system.
</ResponseField>

```json theme={null} theme={null}
{
  "id": "cs_01DEF...",
  "name": "EMS BCS High",
  "facility_id": "fac_01HXY...",
  "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.

<Note>
  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.
</Note>

### Create a cyber system

<span style={{ background: '#3b82f6', color: '#fff', borderRadius: '4px', padding: '2px 8px', fontWeight: 700, fontSize: '0.8rem', marginRight: '8px' }}>POST</span> `/cyber-systems`

**Operation:** `createCyberSystem` - Creates a new BES Cyber System in your Raptor Comply tenant.

***

### Update a cyber system

<span style={{ background: '#f59e0b', color: '#fff', borderRadius: '4px', padding: '2px 8px', fontWeight: 700, fontSize: '0.8rem', marginRight: '8px' }}>PATCH</span> `/cyber-systems/{id}`

**Operation:** `updateCyberSystem` - Partially updates the properties of an existing BES Cyber System.

***

### Delete a cyber system

<span style={{ background: '#ef4444', color: '#fff', borderRadius: '4px', padding: '2px 8px', fontWeight: 700, fontSize: '0.8rem', marginRight: '8px' }}>DELETE</span> `/cyber-systems/{id}`

**Operation:** `deleteCyberSystem` - Permanently removes a BES Cyber System from your Raptor Comply tenant.

***

### List cyber systems by facility

<span style={{ background: '#22c55e', color: '#fff', borderRadius: '4px', padding: '2px 8px', fontWeight: 700, fontSize: '0.8rem', marginRight: '8px' }}>GET</span> `/facilities/{facilityId}/cyber-systems`

**Operation:** `getCyberSystemsByFacility` - Returns all BES Cyber Systems associated with the specified facility. Useful for scoped queries when you only need the BCS inventory for a single site.

***

### List cyber systems by control center

<span style={{ background: '#22c55e', color: '#fff', borderRadius: '4px', padding: '2px 8px', fontWeight: 700, fontSize: '0.8rem', marginRight: '8px' }}>GET</span> `/control-centers/{controlCenterId}/cyber-systems`

**Operation:** `getCyberSystemsByControlCenter` - Returns all BES Cyber Systems associated with the specified control center.