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):
FieldTypeDescription
NameMandatoryThe connector name
connectorZoneIDMandatoryConnector zone ID

📘

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:

201Connector created successfully
400Bad request
401Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.
409Conflict - Connector already exists with the same name
500Internal server error

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):
FieldTypeDescription
NameMandatoryThe connector zone name

Example:

{
  "name":"Connector Zone US"
}

Successful Response Format:

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

Response Codes:

CodeDescription
201Connector Zone created successfully
400Bad request
401Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.
409Conflict - Connector Zone already exists with the same name
500Internal server error

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:

CodeDescription
200Connector Zone information retrieved successfully
400Bad request
401Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.
404Connector Zone not found
500Internal server error

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:
Query ParamDescription
PageSizeSpecify the maximum number of tags to retrieve.
PageNumberPage number 1 will retrieve the first tags.

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:

CodeDescription
200Connector Zones retrieved successfully
400Bad request
401Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.
500Internal server error

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:

CodeDescription
204Connector Zone updated successfully
400Bad request
401Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.
404Connector Zone not found
500Internal server error

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
CodeDescription
204Connector zone deleted successfully
400Bad request
401Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.
404Connector zone not found
500Internal server error