Atmos Cloud API: Connectors and Connector Zones

The Atmos Cloud API allows administrators to have programmatic control over connectors and connector zones. Click here to learn more about generating an API token.

📘

NOTE

This is a limited release feature. For more information contact Axis Security Support: [email protected]

Create a new connector

The management API allows administrators to create new connector.
A successful response will return a 201 response with the connector zone details.

Request Details:

• Request URL: “admin-api.axissecurity.com/api/v1/connectors”
• Request Method: POST
• Request Headers: Authorization: “{API Token}”
• Request Body (JSON):

📘

NOTE

The ID parameter is NOT required when adding a new connector via the API

Example:

{
"name":"myconnector",
"connectorZoneID":"string",
}

Successful Response Format:

{
"id":"string",
"name":"string",
"connectorZoneID": "string",
"command": "sudo bash < <(curl -fskSL https://ops.stg.axissecurity.com/2wn5m0Cn/install)"
}

Response Codes:

Create a new connector zone

The management API allows administrators to create new connector zones.
A successful response will return a 201 response with the connector zone details.

Request Details:

• Request URL: “admin-api.axissecurity.com/api/v1/connectorzones”
• Request Method: POST
• Request Headers: Authorization: “{API Token}”
• Request Body (JSON):

Example:

{
  "name":"Connector Zone US"
}

Successful Response Format:

{
  "id": "string",
  "name":"Connector Zone US"
}

Response Codes:

Get the details of an existing connector zone

To get the details of an existing connector zone, the connector zone's ID should be added to the request URL.

Request Details:

• Request URL: “admin-api.axissecurity.com/api/v1/connectorzones/<connector zone ID>”
• Request Method: GET
• Request Headers: Authorization: “{API Token}”
• Request Body: empty

Successful Response Format:

{
"id":"string",
"name":"string"
}

Response Codes:

Get a list of existing connector zones

Request Details

• Request URL: “admin-api.axissecurity.com/api/v1/connectorzones?pageSize=100&pageNumber=1”
• Request Method: GET
• Request Headers: Authorization: “{API Token}”
• Query params:

Successful Response Format

{
"pageNumber":1,
"pageSize":100,
"firstPage":"<URL to retrieve first page>",
"lastPage":"<URL to retrieve last page>",
"totalPages":1,
"totalRecords":50,
"nextPage":"<URL to retrieve next page>",
"previousPage":"<URL to retrieve previous page>",
"data":[
  {
   "id":"string",
   "name":"string",
   "description":"string",
   "connectorZones":[
     {
      "id":"string",
      "Name":"string"
     }
    ]
   }
 ]
}

Response Codes:

Update an existing connector zone

To update an existing tag, the tag's ID should be added to the request URL.
A successful response will return a 204 response with the tag details.

📘

Note

The values stated in the request body will override the user's existing values.

Request Details:
Request URL: “admin-api.axissecurity.com/api/v1/connectorzones/<connector zone id>”
Request Method: POST
Request Headers: Authorization: “{API Token}”

Example:

{
"name":"Connector Zone US"
}

Successful Response Format

{
"id":"string",
"name":"Connector Zone US"
}

Response Codes:

Delete a connector zone

To delete an existing connector zone, the connector zone's ID should be added to the request URL.
A successful response will return a 204 response with an empty body.

Request Details

• Request URL: “admin-api.axissecurity.com/api/v1/connectorzone/<connector zone id>”
• Request Method: Delete
• Request Headers: Authorization: “{API Token}”
• Request Body: empty