Atmos Cloud API: SSL Exclusions

The Atmos Cloud API allows administrators to have programmatic control over SSL exclusions. 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 SSL exclusion

The management API allows administrators to create new SSL exclusion.

Request Details

  • Request URL: “admin-api.axissecurity.com/api/v1/sslexclusions”
  • Request Method: POST
  • Request Headers: Authorization: “{API Token}”
  • Request Body (JSON):
FieldTypeDescription
NameMandatoryThe SSL exclusion name
EnabledOptionalEnter False if want to disable the SSL exclusion.

Default: True
ExcludedDomainsOptionalA list of FQDN and DNS wildcards to be excluded

📘

NOTE

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

Request Format:

{
  "name":"ACME",
  "excludedDomains": ["*.acme.com"],
}

Successful Response Format:

{
  "id":"string",
  "name":"ACME",
  "excludedDomains": ["*.acme.com"],
  "type": "Custom",
}

Response Codes:

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

Get the details of an existing ssl exclusion

To get the details of an existing ssl exclusion, the ssl exclusion ID should be added to the request URL.

Request Details

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

Successful Response Format (For custom ssl exclusion):

{
  "id":"string",
  "name":"ACME",
  "excludedDomains": ["*.acme.com"],
  "type": "Custom",
}

Successful Response Format (For predefined ssl exclusion):

{
  "id":"string",
  "name":"ACME",
  "excludedDomains": ["*.acme.com"],
  "type": "Predefined",
}

Response Codes:

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

Get a list of existing ssl exclusions

Request Details

  • Request URL: “admin-api.axissecurity.com/api/v1/sslexclusions?pageSize=100&pageNumber=1”
  • Request Method: GET
  • Request Headers: Authorization: “{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":"ACME",
      "excludedDomains": ["*.acme.com"],
      "type": "Custom",
    }
  ]

Response Codes:

CodeDescription
200Web categories 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 ssl exclusion

To update an existing ssl exclusion, the ssl exclusion's ID should be added to the request URL.
A successful response will return a 204 response with the ssl exclusion's details.

📘

Note

For predefined ssl exclusions, which are managed by Axis, the Name field cannot be updated.

Request Details:
Request URL: “admin-api.axissecurity.com/api/v1/sslexclusions/<ssl exclusion ID>”
Request Method: POST
Request Headers: Authorization: “{API Token}”

Request Format:

{
  "name":"ACME",
  "excludedDomains": ["*.acme.com"],
}

Successful Response Format:

{
  "id":"string",
  "name":"ACME",
  "excludedDomains": ["*.acme.com"],
  "type": "Custom",
}

Response Codes:

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

Delete a ssl exclusion

To delete an existing ssl exclusion, the web ssl exclusion's ID should be added to the request URL.

📘

Note

Predefined ssl exclusions are managed by Axis and cannot be deleted.

Request Details

  • Request URL: “admin-api.axissecurity.com/api/v1/ssl exclusions/<ssl exclusion ID>”
  • Request Method: Delete
  • Request Headers: Authorization: “{API Token}”
  • Request Body: empty

Response Codes:

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