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
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
{- "policyName": "DefaultPolicy",
- "enabled": true
}
- 200
{- "policyUuid": "a5d99991-cf4a-44a1-8c56-f670f0c9b9a9",
- "policyName": "DefaultPolicy",
- "enabled": true,
- "version": "2021.05.14.200949",
- "actionName": "Block + Notify",
- "type": "ALL",
- "exceptions": [
- {
- "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "exceptionUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "source": {
- "cidrs": [
- "192.0.2.0/24",
- "198.51.100.0/24"
]
}
}
]
}
Deprecated: 2022-03-21. Use the new /outbound endpoints. Retrieve a current list of permitted domain entriesDeprecated
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
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "domainNames": [
- "example.com"
], - "domains": [
- {
- "domainName": "example.com",
- "ports": [
- 443
]
}
], - "totalCount": 1,
- "next": "abcd",
- "limit": 1
}
Deprecated: 2022-03-21. Use the new /outbound endpoints. Add domain entries to the permit listDeprecated
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
{- "domainNames": [
- {
- "domainName": "example.com",
- "ports": [
- 443
]
}
]
}
Deprecated: 2022-03-21. Use the new /outbound endpoints. Delete domain entries from the permit listDeprecated
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
{- "domainNames": [
- {
- "domainName": "example.com",
- "ports": [
- 443
]
}
]
}
Deprecated: 2022-03-21. Use the new /outbound endpoints. Retrieve the most recent domain distribution list on the appliance(s)Deprecated
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "limit": 0,
- "totalCount": 0,
- "cursor": "string",
- "distributions": [
- {
- "distributionUuid": "string",
- "submitTime": "string",
- "status": "string",
- "applianceId": 0
}
]
}
Deprecated: 2022-03-21. Use the new /outbound endpoints. Distribute permit list entries and domain filtering configuration to the appliance(s)Deprecated
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
{- "applianceIds": [
- 1
]
}
- 200
{- "distributionQueued": {
- "applianceIds": [
- 0
], - "distributionUuid": "string"
}, - "appliancesUpToDate": {
- "applianceIds": [
- 0
]
}, - "submissionFailed": {
- "applianceIds": [
- {
- "applianceId": 0,
- "error": "string"
}
]
}
}
Deprecated: 2022-03-21. Use the new /outbound endpoints. Retrieve the domain filtering configuration listDeprecated
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "limit": 0,
- "totalCount": 0,
- "next": "string",
- "domainPolicies": [
- {
- "policyUuid": "a5d99991-cf4a-44a1-8c56-f670f0c9b9a9",
- "policyName": "DefaultPolicy",
- "enabled": true,
- "version": "2021.05.14.200949",
- "actionName": "Block + Notify",
- "type": "ALL",
- "exceptions": [
- {
- "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "exceptionUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "source": {
- "cidrs": [
- "192.0.2.0/24",
- "198.51.100.0/24"
]
}
}
]
}
]
}
Deprecated: 2022-03-21. Use the new /outbound endpoints. Create a domain filtering configurationDeprecated
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
{- "policyName": "DefaultPolicy",
- "enabled": true,
- "exceptions": [
- {
- "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "source": {
- "cidrs": [
- "192.0.2.0/24",
- "198.51.100.0/24"
]
}
}
]
}
- 200
{- "policyUuid": "a5d99991-cf4a-44a1-8c56-f670f0c9b9a9",
- "policyName": "DefaultPolicy",
- "enabled": true,
- "version": "2021.05.14.200949",
- "actionName": "Block + Notify",
- "type": "ALL",
- "exceptions": [
- {
- "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "exceptionUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "source": {
- "cidrs": [
- "192.0.2.0/24",
- "198.51.100.0/24"
]
}
}
]
}
Deprecated: 2022-03-21. Use the new /outbound endpoints. Retrieve the status of the domain distribution job on the appliance(s)Deprecated
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "distributionUuid": "string",
- "entriesVersion": "string",
- "policyVersion": "string",
- "status": "string",
- "distributions": [
- {
- "submitTime": "string",
- "status": "string",
- "applianceId": 0
}
]
}