Atmos Cloud API: Web Categories
The Atmos Cloud API allows administrators to have programmatic control over web categories. Click here to learn more about generating an API token.
Create a new web category
The management API allows administrators to create new web category.
Request Details
- Request URL: “admin-api.axissecurity.com/api/v1/webcategories”
- Request Method: POST
- Request Headers: Authorization: “Bearer {API Token}”
- Request Body (JSON):
Field | Type | Description |
---|---|---|
Name | Mandatory | The connector name |
Description | Optional | Description of the web category |
IncludedDomainsOrUrls | Optional | A list of FQDN/URLs and DNS wildcards to be included in the web category. |
ExcludedDomainsOrUrls | Optional | A list of FQDN/URLs and DNS wildcards to be excluded from the web category. |
ConnectorZoneID | Optional | The connector zone ID Default: Public Zone |
NOTE
The ID parameter is NOT required when adding a new web category via the API
Request Format:
{
"name":"ACME Resources",
"description": "ACME Resources.",
"IncludedDomainsOrUrls": ["acme.com","*.ustream.tv"],
"ExcludedDomainsOrUrls": ["acme.com/sport/*"],
"connectorZoneID": "string"
}
Successful Response Format:
{
"id":"string",
"name":"ACME Resources",
"description": "ACME Resources.",
"includedDomainsOrUrls": ["acme.com","*.ustream.tv"],
"excludedDomainsOrUrls": ["acme.com/sport/*"],
"connectorZoneID": "string",
"type": "Custom"
}
Response Codes:
Code | Description |
---|---|
201 | Web category created successfully |
400 | Bad request |
401 | Unauthorized access. Make sure the API token includes writing permissions. Click here for more information. |
409 | Conflict - Web category already exists with the same name |
500 | Internal server error |
Get the details of an existing web category
To get the details of an existing Web category, the Web category ID should be added to the request URL.
Request Details
- Request URL: “admin-api.axissecurity.com/api/v1/webcategories/<web category ID>”
- Request Method: GET
- Request Headers: Authorization: “Bearer {API Token}”
- Request Body: empty
Successful Response Format (For custom web category):
{
"id":"string",
"name":"ACME Resources",
"description": "ACME Resources.",
"includedDomainsOrUrls": ["acme.com","*.ustream.tv"],
"excludedDomainsOrUrls": ["acme.com/sport/*"],
"connectorZoneID": "string",
"type": "Custom"
}
Successful Response Format (For predefined web category):
{
"id":"string",
"name":"Unconfirmed SPAM Sources",
"description": "Possible sources of SPAM.",
"includedDomainsOrUrls": [],
"excludedDomainsOrUrls": [],
"connectorZoneID": "string",
"type": "Predefined"
}
Response Codes:
Code | Description |
---|---|
200 | Web category information retrieved successfully |
400 | Bad request |
401 | Unauthorized access. Make sure the API token includes writing permissions. Click here for more information. |
404 | Web category not found |
500 | Internal server error |
Get a list of existing web categories
Request Details
- Request URL: “admin-api.axissecurity.com/api/v1/webcategories?pageSize=100&pageNumber=1”
- Request Method: GET
- Request Headers: Authorization: “Bearer {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":"Unconfirmed SPAM Sources",
"description": "Possible sources of SPAM.",
"includedDomainsOrUrls": [],
"excludedDomainsOrUrls": [],
"connectorZoneID": "string",
"type": "Predefined"
}
]
Response Codes:
Code | Description |
---|---|
200 | Web categories 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 web category
To update an existing web category, the web category's ID should be added to the request URL.
A successful response will return a 204 response with the web category's details.
Note
For predefined web categories, which are managed by Axis, the Name and Description fields cannot be updated.
Request Details:
Request URL: “admin-api.axissecurity.com/api/v1/webcategories/<web category ID>”
Request Method: PUT
Request Headers: Authorization: “Bearer {API Token}”
Request Format:
{
"name":"ACME Resources",
"description": "ACME Resources.",
"includedDomainsOrUrls": ["acme.com","*.ustream.tv"],
"excludedDomainsOrUrls": ["acme.com/sport/*"],
"connectorZoneID": "string",
"type": "Custom"
}
Successful Response Format:
{
"id":"string",
"name":"ACME Resources",
"description": "ACME Resources.",
"includedDomainsOrUrls": ["acme.com","*.ustream.tv"],
"excludedDomainsOrUrls": ["acme.com/sport/*"],
"connectorZoneID": "string",
"type": "Custom"
}
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 web category
To delete an existing web category, the web category's ID should be added to the request URL.
Note
Predefined web categories are managed by Axis and cannot be deleted.
Request Details
- Request URL: “admin-api.axissecurity.com/api/v1/webcategories/<web category ID>”
- Request Method: Delete
- Request Headers: Authorization: “Bearer {API Token}”
- Request Body: empty
Response Codes:
Code | Description |
---|---|
204 | Web category deleted successfully |
400 | Bad request |
401 | Unauthorized access. Make sure the API token includes writing permissions. Click here for more information. |
404 | Web category not found |
500 | Internal server error |
Updated 10 months ago