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):

📘

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:

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:

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:

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:

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: PUT
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:

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