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):
Field | Type | Description |
---|---|---|
Name | Mandatory | The connector name |
connectorZoneID | Mandatory | Connector 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:
201 | Connector created successfully |
400 | Bad request |
401 | Unauthorized access. Make sure the API token includes writing permissions. Click here for more information. |
409 | Conflict - Connector already exists with the same name |
500 | Internal 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):
Field | Type | Description |
---|---|---|
Name | Mandatory | The connector zone name |
Example:
{
"name":"Connector Zone US"
}
Successful Response Format:
{
"id": "string",
"name":"Connector Zone US"
}
Response Codes:
Code | Description |
---|---|
201 | Connector Zone created successfully |
400 | Bad request |
401 | Unauthorized access. Make sure the API token includes writing permissions. Click here for more information. |
409 | Conflict - Connector Zone already exists with the same name |
500 | Internal 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:
Code | Description |
---|---|
200 | Connector Zone information retrieved successfully |
400 | Bad request |
401 | Unauthorized access. Make sure the API token includes writing permissions. Click here for more information. |
404 | Connector Zone not found |
500 | Internal 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 Param | Description |
---|---|
PageSize | Specify the maximum number of tags to retrieve. |
PageNumber | Page 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:
Code | Description |
---|---|
200 | Connector Zones retrieved successfully |
400 | Bad request |
401 | Unauthorized access. Make sure the API token includes writing permissions. Click here for more information. |
500 | Internal 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:
Code | Description |
---|---|
204 | Connector Zone updated successfully |
400 | Bad request |
401 | Unauthorized access. Make sure the API token includes writing permissions. Click here for more information. |
404 | Connector Zone not found |
500 | Internal 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
Code | Description |
---|---|
204 | Connector zone deleted successfully |
400 | Bad request |
401 | Unauthorized access. Make sure the API token includes writing permissions. Click here for more information. |
404 | Connector zone not found |
500 | Internal server error |
Updated 4 days ago