> For the complete documentation index, see [llms.txt](https://help.security.gallagher.com/knowledge-hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.security.gallagher.com/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-features.md).

# REST API - features

Review REST API capabilities, licensed editions, use cases, and limitations.

The Command Centre REST API lets a third-party system read from and write to Command Centre over HTTPS. It covers cardholder management, live status monitoring, system overrides, reporting, and bulk operations.

## What the API covers

| Capability                | Examples                                                                    |
| ------------------------- | --------------------------------------------------------------------------- |
| **Cardholder management** | Create, update, and disable cardholders, assign cards, manage access groups |
| **Status monitoring**     | Real-time door, reader, and zone state, and alarm state                     |
| **System overrides**      | Lock and unlock doors, arm and disarm zones, isolate items                  |
| **Reporting and queries** | Pull historical events, run reports, fetch configuration                    |
| **Bulk operations**       | CSV-style mass updates via API endpoints                                    |

The API is the right path for HR system integration (joiner, mover, leaver), building management system integration, visitor management custom flows, and third-party guard tour or incident systems.

## Licensed editions

The REST API is delivered as five separately licensed APIs.

| Edition                                 | Part # | What it does                                                                                                                                         |
| --------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Events & Alarms                         | C12772 | Retrieve historical and monitor live alarms and events; acknowledge, process, and note; filter by group, type, source, cardholder, time, or division |
| Cardholders                             | C12784 | Create, modify, and delete cardholders; real-time cardholder sync                                                                                    |
| View Status                             | C12810 | Current status of Door, Access Zone (including zone count), Alarm Zone, and Fence Zone (including voltage and outputs)                               |
| Overrides                               | C12812 | Override Door, Access Zone, Alarm Zones, Fence Zones, Macros, and Outputs                                                                            |
| Create Events & Alarms (Inbound Events) | C12820 | Receive external events as alarms, instructions, site-plan indications, notifications, and audit trail                                               |

Developer documentation lives at **gallaghersecurity.github.io**. Contact `interfaces@security.gallagher.com` for API documentation.

## Limitations

* Not every Command Centre capability is in the API. Deep configuration tasks such as controller commissioning, complex action plans, and hardware-level setup remain client-only.
* The API surface evolves with Command Centre versions. Twice-yearly releases sometimes deprecate or change endpoints, so integrators must track the Command Centre version.
* Rate limits exist but are not documented in detail. The Cloud API Gateway has rate limiting; on-prem direct calls are bounded by server capacity.

***

🔗 **Related**

* [REST API - Setting up REST API in Command Center](/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-setting-up-rest-api-in-command-center.md). Enable the web server and create the REST Client.
* [Cloud API Gateway](/knowledge-hub/products/cloud-services/cloud-api-gateway.md). Reach the REST API without opening firewall ports.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.security.gallagher.com/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-features.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
