Atmos Cloud API: Tags

The Atmos Cloud API allows administrators to have programmatic control over applications tags. 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 application tag

The management API allows administrators to create new application tags.
A successful response will return a 201 response with the tag details.

Request Details:

  • Request URL: “admin-api.axissecurity.com/api/v1/tags”
  • Request Method: POST
  • Request Headers: Authorization: “Bearer {API Token}”
  • Request Body (JSON):
FieldTypeDescription
NameMandatoryThe tag name
DescriptionOptionalThe tag description
ApplicationsOptionalA list of applications to which the tag is added. The "applications" field is a list of objects, where each object contains an “ID” field with the application's ID.

📘

NOTE

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

Example:

{
"name":"mytag",
"description": "string",
"applications":[
          {
           "id":"string"
          }
        ]
}

Successful Response Format:

{
"id":"string",
"name":"string",
"description": "string",
"applications":[
  {
   "id":"string",
   "name":"string"
  }
 ]
}

Response Codes:

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

Get the details of an existing tag

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

Request Details:

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

Successful Response Format:

{
"id":"string",
"name":"string",
"description": "string",
"applications":[
  {
   "id":"string",
   "name":"string"
  }
 ]
}

Response Codes:

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

Get a list of existing tags

Request Details

  • Request URL: “admin-api.axissecurity.com/api/v1/tags?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":"string",
   "description":"string",
   "applications":[
     {
      "id":"string",
      "Name":"string"
     }
    ]
   }
 ]
}

Response Codes:

CodeDescription
200Tags 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 tag

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/tags/<tag id>”
Request Method: POST
Request Headers: Authorization: “Bearer {API Token}”

Example:

{
"name":"mytag",
"description":"string",
"applications":[
          {
           "id":"string"
          }
        ]
}

Successful Response Format

{
"id":"string",
"name":"string",
"description":"string",
"applications":[
  {
   "id":"string",
   "name":"string"
  }
 ]
}

Response Codes:

CodeDescription
204Tag updated successfully
400Bad request
401Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.
404Tag not found
409Conflict - Tag already exists with the same name
500Internal server error

Delete a tag

To delete an existing tag, the tag'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/tags/<tag id>”
  • Request Method: Delete
  • Request Headers: Authorization: “Bearer {API Token}”
  • Request Body: empty
CodeDescription
204Tag deleted successfully
400Bad request
401Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.
404Tag not found
500Internal server error