Atmos Cloud API: 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.

Create a new connector zone

The management API allows administrators to create new connector zone.

Request Details

  • Request URL: “admin-api.axissecurity.com/api/v1/connectorzones”
  • Request Method: POST
  • Request Headers: Authorization: “Bearer {API Token}”
  • Request Body (JSON):
FieldTypeDescription
NameMandatoryThe connector name
DescriptionOptionalDescription of the connector zone

📘

NOTE

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

Request Format:

{
  "name":"zone1",
  "description": "zone description",
}

Successful Response Format:

{
  "id":"string",
  "name":"zone1",
  "description": "zone description",
  "connectors":[
    {
     "id":"string",
     "name":"string"
    },
  "type": "Regular",
  "purpose": "Access",
}

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 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: “Bearer {API Token}”
  • Request Body: empty

Successful Response Format (For regular zone):

{
  "id":"string",
  "name":"US",
  "description": "US Zone",
  "connectors":[
    {
     "id":"string",
     "name":"string"
    }],
  "type": "Regular",
  "purpose": "Access",
}

Successful Response Format (For log streaming zone):

{
  "id":"string",
  "name":"Default Log Streaming Connector Zone",
  "description": "Log Streaming Zone",
  "connectors":[
    {
     "id":"string",
     "name":"string"
    }],
    "type": "Regular",
    "purpose": "LogStreaming",
}

Successful Response Format (For public zone):

{
  "id":"string",
  "name":"Public",
  "description": "Public Zone",
  "type": "InternetZone",
  "purpose": "Access",
}

Response Codes:

CodeDescription
200Connector information retrieved successfully
400Bad request
401Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.
404Connector 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: “Bearer {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":"US",
        "description": "US Zone"
        "connectors":[
          {
           "id":"string",
           "name":"string"
          },
        ]
        "type": "Regular",
      }
    ]
}

Response Codes:

CodeDescription
200Connector zone 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 connector, the connector's ID should be added to the request URL.
A successful response will return a 204 response with the connector zone's details.

📘

Note

Public zone cannot be updated.

Request Details:
Request URL: “admin-api.axissecurity.com/api/v1/connectors/<connector ID>”
Request Method: PUT
Request Headers: Authorization: “Bearer {API Token}”

Request Format:

{
  "name":"US",
  "description": "US Zone",
}

Successful Response Format:

{
  "name":"US",
  "description": "US Zone",
  "connectors":[
   {
    "id":"string",
    "name":"string"
   }],
  "type": "Regular",
}

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, the connector's ID should be added to the request URL.

📘

Note

Public and Log Streaming connector zones cannot be deleted.

Request Details

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

Response Codes:

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