Domain Filtering

This is a create, read, update, delete (CRUD) API that is used to manage domain filtering list and configuration

Deprecated: 2022-03-21. Use the new /outbound endpoints. Update the domain filtering configurationDeprecated

put/domains/configurations/{domainPolicyUuid}
Request
path Parameters
domainPolicyUuid
required
string
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
enabled
required
boolean

Switch of the policy

policyName
string

Name of the policy

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "policyName": "DefaultPolicy",
  • "enabled": true
}
Response samples
application/json
{
  • "policyUuid": "a5d99991-cf4a-44a1-8c56-f670f0c9b9a9",
  • "policyName": "DefaultPolicy",
  • "enabled": true,
  • "version": "2021.05.14.200949",
  • "actionName": "Block + Notify",
  • "type": "ALL",
  • "exceptions": [
    ]
}

Deprecated: 2022-03-21. Use the new /outbound endpoints. Retrieve a current list of permitted domain entriesDeprecated

get/domains/permitlists/entries

To retrieve a specific number of entries, specify that value using the maximum parameter. The default is 10 and the max is 1000. Use the domains property for information about domain entries and ports. The domainNames (to be deprecated) property contains information about only domain entries

Request
query Parameters
cursor
string
limit
integer <int32> <= 1000
Default: 10
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "domainNames": [
    ],
  • "domains": [
    ],
  • "totalCount": 1,
  • "next": "abcd",
  • "limit": 1
}

Deprecated: 2022-03-21. Use the new /outbound endpoints. Add domain entries to the permit listDeprecated

post/domains/permitlists/entries
Request
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
required
Array of objects (DomainEntry)
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "domainNames": [
    ]
}

Deprecated: 2022-03-21. Use the new /outbound endpoints. Delete domain entries from the permit listDeprecated

delete/domains/permitlists/entries
Request
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
required
Array of objects (DomainEntry)
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "domainNames": [
    ]
}

Deprecated: 2022-03-21. Use the new /outbound endpoints. Retrieve the most recent domain distribution list on the appliance(s)Deprecated

get/domains/permitlists/distributions
Request
query Parameters
cursor
string
limit
integer <int32>
Default: 10
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "limit": 0,
  • "totalCount": 0,
  • "cursor": "string",
  • "distributions": [
    ]
}

Deprecated: 2022-03-21. Use the new /outbound endpoints. Distribute permit list entries and domain filtering configuration to the appliance(s)Deprecated

post/domains/permitlists/distributions
Request
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
applianceIds
Array of integers <int64>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "applianceIds": [
    ]
}
Response samples
application/json
{
  • "distributionQueued": {
    },
  • "appliancesUpToDate": {
    },
  • "submissionFailed": {
    }
}

Deprecated: 2022-03-21. Use the new /outbound endpoints. Retrieve the domain filtering configuration listDeprecated

get/domains/configurations
Request
query Parameters
cursor
string
limit
integer <int32>
Default: 10
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "limit": 0,
  • "totalCount": 0,
  • "next": "string",
  • "domainPolicies": [
    ]
}

Deprecated: 2022-03-21. Use the new /outbound endpoints. Create a domain filtering configurationDeprecated

post/domains/configurations
Request
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
enabled
required
boolean

Switch of the policy

Array of objects (DomainPolicyException)

Exception list that the policy will target

policyName
string

Name of the policy

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "policyName": "DefaultPolicy",
  • "enabled": true,
  • "exceptions": [
    ]
}
Response samples
application/json
{
  • "policyUuid": "a5d99991-cf4a-44a1-8c56-f670f0c9b9a9",
  • "policyName": "DefaultPolicy",
  • "enabled": true,
  • "version": "2021.05.14.200949",
  • "actionName": "Block + Notify",
  • "type": "ALL",
  • "exceptions": [
    ]
}

Deprecated: 2022-03-21. Use the new /outbound endpoints. Retrieve the status of the domain distribution job on the appliance(s)Deprecated

get/domains/permitlists/distributions/{domainDistributionId}
Request
path Parameters
domainDistributionId
required
string
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "distributionUuid": "string",
  • "entriesVersion": "string",
  • "policyVersion": "string",
  • "status": "string",
  • "distributions": [
    ]
}