> 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/configuration-client/site-installation/server-properties/web-services.md).

# Web Services

### Introduction

The Web Services tab allows you to replace the web service certificate with an alternate certificate, when using the Mobile Client, and configure the server base port for the REST API.

REST is short for REpresentational State Transfer. It is a resource-based API that allows developers to perform requests and receive responses via HTTP protocol. REST API requires the following licence strings for a site to be able to use it:

* `RESTEvents=1`
* `RESTCardholders=1`
* `RESTOverrides=1`
* `RESTStatus=1`
* `RESTCreateEvents=1`

### Procedure

1. Open the **Command Centre Server Properties** window. [How?](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/opening-the-server-properties-window.md)
2. Click the **Web Services** tab.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-e67cd1b0577d83685af44accd558f1947507104d%2Fwebservicestab.png?alt=media)
3. If you wish to change the Command Centre Mobile App certificate:
   1. Tick the **Enable Local Network Connections** checkbox,
   2. Change the port in the **Server Base Port** field, then
   3. Select the appropriate **Device Identification** from the drop-down.

      Refer to [Changing the Web Services](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/web-services/changing-the-web-services.md) for further instructions.
4. If **REST API** is required, tick the **Enable Local Network Connections** checkbox.
5. Change the REST API **Server Base Port** if required.

   **Note (if changing the port):** You will also need to reconfigure the SSL certificate. Refer to [Changing the Web Services](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/web-services/changing-the-web-services.md) for further instructions.

   **IMPORTANT:** If the **Enable REST Clients with no client certificate** checkbox is unchecked (default), REST Client items **must** have a Client Certificate Thumbprint assigned to them to work. Gallagher STRONGLY recommends leaving it unchecked, as requiring client certificates greatly increases security.

   If this checkbox is checked, REST Client items do not need a Client Certificate Thumbprint assigned to them, but they may have one. If they do have one, it must be valid.

   Whether this checkbox is checked or not, any certificate thumbprint entered in a REST Client item’s **Client Certificate Thumbprint** field must match the client certificate (must be valid).

   The 'Status' section updates to show the REST start-up state, (e.g. running, failed to start), and any relevant error information.
6. The 'Gallagher API Services Server' settings are enabled if your site is licensed for the [Gallagher SIP Integration](https://help.security.gallagher.com/knowledge-hub/configuration-client/licensable-features/sip-integration.md).

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-ebe36c6c8fe1170ed22c36c6569103868d3319fb%2Fwebservicestab_apiserversettings.png?alt=media)

   Change the Gallagher API Services Server **Server Base Port** if required. This is the port used by the Gallagher SIP Endpoint Service to communicate with the Command Centre Server. The port you set here must match the port you specify in the Gallagher SIP Setup Utility. Default is 8908.
7. If you have enabled the REST API port by completing Steps 4 and 5, you also need to create a REST Client item. See [Creating a REST API Client item](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/services-and-workstations/creating-a-rest-api-client-item.md) for further detail.
8. The 'Engage Firmware Server' and 'Visitor Management Server' settings are enabled if your site is licensed for either of these.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-6baf8e3610ed8cea1fd359e73367fc23c4bd7883%2Fwebservicestab_engageandvmserversettings.png?alt=media)

   Change the Server Base Port for either of these if required.

   See [Visitor Management Application Installation Instructions](https://help.security.gallagher.com/knowledge-hub/configuration-client/licensable-features/visitor-management/visitor-management-application-installation-instructions.md) for further detail.
9. Click **OK** to exit and save your changes.

   Click **Cancel** to exit without saving your changes.

   Click **Apply** to save your changes and stay in this window.

### In This Section

* [Changing the Web Services](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/web-services/changing-the-web-services.md)


---

# 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/configuration-client/site-installation/server-properties/web-services.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.
