---
title: IRIS+™ Rest API
slug: enterprise/iristm-rest-api
docTags: 
createdAt: 2023-09-13T09:02:10.179Z
---

The IRIS+™ API has been created to provide secure and easy access to your account data to support custom use cases and integration needs. It is built using RESTFUL principles.

The API is normally disabled. Please reach out to our support or sales organization to enable access to the API for your account and installation.

The current version is version 2.

# Endpoint and documentation

The main endpoint for the API is [https://api.irisplus.ai/docs/#iris-external-api-version-3](https://api.irisplus.ai/docs/#iris-external-api-version-3). This is also where you find the detailed API documentation.

The main endpoint for the API is [https://api.irisity.io/v2](https://api.irisity.io/v2).

# Getting started

To get access to the functionality of IRIS+ API you will need an **API key **and an **Access token**.

## API key

The system administrator needs to create an API key with the relevant permission.

For Iristy-hosted cloud accounts, please contact Irisity support to get an API key:

Customer Support: [technicalsupport@irisity.com](mailto\:technicalsupport@irisity.com)

1. Log in as system administrator
2. Go to the **Console** tab and then choose **API Keys**

![](https://api.archbee.com/api/optimize/0qwUIPTrS6-vWLcHFHOFA-Xc7bR7qvDn-DIreLFA4bi-20240804-124214.png)

      3\. Click + Add

      4\. Set Key name

::Image[]{src="https://api.archbee.com/api/optimize/0qwUIPTrS6-vWLcHFHOFA-DdPJp8oo0nYzbq0o0MOic-20240804-125112.png" size="38" width="444" height="147" position="center" showCaption="false"}

     5\. Click "+ Add"

     6\. Select the API key in the list and add the below permissions, depending on needs.     

***To maximize security, Make sure to only grant access to the functionality required ***

- Accounts -> Read
- Events -> Read, Update
- Folders -> Read
- Rules -> Read
- Cameras -> Read, Update
- Click "Save"
- Deliver the API key securely to the intended customer.

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/Se2Q9NCf5gdHkoiyPXRst_image.png" size="74" width="705" height="624" position="center" caption="Example API key permissions for a fully-featured custom integration" alt="Example API key permissions for a fully-featured custom integration" showCaption="true"}

Access token


The administrator of the relevant account needs to create a service account to be able to generate an access token for the API calls.

### Create a service account

1. Log in as an account administrator
2. Go to Settings and then the User tab
3. Click "+ Add"

![](https://api.archbee.com/api/optimize/0qwUIPTrS6-vWLcHFHOFA-Uic0dwuoeAN4-_lZf9QDI-20240804-130131.png)

     4\. Choose "Create service account" and pick a name

     5\. (Optional) Add a description

     6\. Click "Create service account"

::Image[]{src="https://api.archbee.com/api/optimize/0qwUIPTrS6-vWLcHFHOFA-Z81t1F8C88QQRmSRx04bf-20240804-130327.png" size="54" width="459" height="536" position="center" showCaption="false"}

### Generate an access token

1. Select the service account
2. Click "Get token"
3. (Recommended) Check the "Token expiration" and choose the expiration date. *We always recommend setting a token expiration to enforce rotating keys periodically.*
4. Click "Get token"
5. Copy the token and store it securely for later use

::Image[]{src="https://api.archbee.com/api/optimize/0qwUIPTrS6-vWLcHFHOFA-yvTy-4nB3fLkx-BG_oVcn-20240804-130514.png" size="74" width="694" height="322" position="center" showCaption="false"}

## Using the API

To start using the external API, you need to set two custom headers, `X-API-KEY` and `X-ACCESS-TOKEN`:

1. Add the **API key **generated above as the value for the `X-API-KEY` header
2. Add the **Access token** generated above as the value for the `X-ACCESS-TOKEN` header.

## Your first request

To verify your API access you can use curl to get a list of all sensors (cameras) in the account. Curl is built into most modern operating systems. For more details, please see [https://github.com/curl/curl.](https://github.com/curl/curl)

### Curl request

:::BlockQuote
curl [https://api.irisplus.ai/v2/sensors](https://api.irisity.io/v2/sensors)
-H "X-API-KEY:{API-KEY}"
-H "X-ACCESS-TOKEN:{ACCESS-TOKEN}"
:::

### Full documentation

For details about the available operations, options, and data types, please refer to the API documentation at [https://api.irisity.io/v2](https://api.irisity.io/v2).