> 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.md).

# Representational state transfer (REST) API

Integrate Command Centre over HTTP with licensed REST API editions.

The Command Centre REST API lets software developers integrate third-party interfaces with Command Centre over HTTP. There are five separately licensed APIs, each covering a different job.

## The five REST APIs

<table><thead><tr><th width="199">API</th><th width="91.0001220703125">Part number</th><th>What it does</th></tr></thead><tbody><tr><td><strong>Events &#x26; Alarms</strong></td><td><code>C12772</code></td><td>Retrieve historical alarms and events currently stored in the Command Centre database. Monitor for live alarms and events as they are logged. Acknowledge, process, and add notes to alarms. Retrieve only the events that are relevant, using filters for Event Group, Event Type, Event Source, Cardholder, Date and Time, and Division.</td></tr><tr><td><strong>Cardholders</strong></td><td><code>C12784</code></td><td>Import and export cardholder data. Cardholders can be created, modified, and deleted. Used to synchronize cardholder data between systems in real time.</td></tr><tr><td><strong>View Status</strong></td><td><code>C12810</code></td><td>Obtain the current status of items in Command Centre over HTTP: Door, Access Zone (including zone count), Alarm Zone, and Fence Zone (including fence voltage and outputs).</td></tr><tr><td><strong>Overrides</strong></td><td><code>C12812</code></td><td>Override specified items over HTTP: Door, Access Zone, Alarm Zones, Fence Zones, Macros, and Outputs.</td></tr><tr><td><strong>Create Events &#x26; Alarms</strong></td><td><code>C12820</code></td><td>The Inbound Events API allows Command Centre to receive external events from third-party systems, to generate alarms, view alarm instructions, provide alarm indications on site plans, generate notifications, and run reports for a full audit trail of both Gallagher events and events from other systems. This allows Command Centre to be the central monitoring system for the whole site.</td></tr></tbody></table>

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

For further information contact <interfaces@security.gallagher.com>. API documentation is available on request.

## Getting connected

The REST API is served from the Command Centre web server on **port 8904**. Standing it up means creating a REST operator and a REST Client item, generating an API key, and importing client and server certificates.

> ⚠️ The API key contains the username and password. Protect it with client certificates and IP filtering.

> 🧭 **Where to start**
>
> * **Standing it up for the first time?** → [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)
> * **What is an API key?** → [REST API - What is an API Key?](/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-what-is-an-api-key.md)
> * **Certificates?** → [REST API - Certificates](/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-certificates.md)
> * **Connection failing?** → [REST API - Connection](/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-connection.md)
> * **Triaging a Technology Partner integration?** → [REST API - Troubleshooting a Technology Partner Integration](/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-troubleshooting-a-technology.md)

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>REST API - Certificates</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-certificates.md">REST API - certificates</a></td></tr><tr><td><strong>REST API - Connection</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-connection.md">REST API - connection</a></td></tr><tr><td><strong>REST API - Create REST Operator</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-create-rest-operator.md">REST API - create REST operator</a></td></tr><tr><td><strong>REST API - Creating and Importing REST API Certificates</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-creating-and-importing-rest-api-certificates.md">REST API - creating and importing REST API certificates</a></td></tr><tr><td><strong>REST API - Creating the Client Certificate</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-creating-the-client-certificate.md">REST API - creating the client certificate</a></td></tr><tr><td><strong>REST API - Features</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-features.md">REST API - features</a></td></tr><tr><td><strong>REST API - Logs</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-logs.md">REST API - logs</a></td></tr><tr><td><strong>REST API - Setting up REST API in Command Center</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-setting-up-rest-api-in-command-center.md">REST API - setting up REST API in Command Centre</a></td></tr><tr><td><strong>REST API - Troubleshooting a Technology Partner Integration</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-troubleshooting-a-technology.md">REST API - troubleshooting a Technology Partner integration</a></td></tr><tr><td><strong>REST API - What is an API Key?</strong></td><td></td><td></td><td><a href="/knowledge-hub/products/cc-software/configure/interface-options/api/representational-state-transfer-rest-api/rest-api-what-is-an-api-key.md">REST API - what is an API key?</a></td></tr></tbody></table>

***

🔗 **Related**

* [Cloud API Gateway](/knowledge-hub/products/cloud-services/cloud-api-gateway.md). Reach the REST API from a remote or cloud client without opening inbound firewall ports.
* [Controller API (FTCAPI) and Middleware Framework (FMF)](/knowledge-hub/products/cc-software/configure/interface-options/api/controller-api-ftcapi-and-middleware-f.md). The controller-level integration path, for systems that talk through a controller rather than over HTTP.


---

# 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.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.