This is a create, read, update, delete (CRUD) API that is used to manage outbound filtering lists and configurations
Update the outbound filtering configuration
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"
]
}
}
]
}
Retrieve an outbound policy exception
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "exceptionUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "source": {
- "cidrs": [
- "192.0.2.0/24",
- "198.51.100.0/24"
]
}
}
Update an outbound policy exception
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
{- "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "source": {
- "cidrs": [
- "192.0.2.0/24",
- "198.51.100.0/24"
]
}
}
- 200
{- "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "exceptionUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "source": {
- "cidrs": [
- "192.0.2.0/24",
- "198.51.100.0/24"
]
}
}
Fetch an outbound entry lists
To retrieve a specific outbound entry list by number, specify that value. The minimum is 1, the default is 10, and the maximum is 1000.
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "entryLists": [
- {
- "name": "entrylist1",
- "version": "2021:05:16:11:09:00",
- "id": "39649209-0001-0002-0004-988278401537",
- "count": "10"
}
], - "limit": "10",
- "next": "abcd"
}
Create an outbound entry list
Creates a new outbound entry list with the given name.
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
{- "name": "entrylist1"
}
- 200
{- "name": "entrylist1",
- "version": "2021:05:16:11:09:00",
- "id": "39649209-0001-0002-0004-988278401537",
- "count": "10"
}
Get outbound entries for an outbound entry list
To retrieve a specific number of outbound entries for the given outbound entry list, specify that value using the limit parameter. The default is 10 and the max is 1000.
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "limit": 10,
- "next": "abcd",
- "entries": [
- {
- "entry": "example.com",
- "ports": [
- 443
]
}
]
}
Create outbound entries for an outbound entry list
Add outbound entries to an outbound entry list
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
[- {
- "entry": "example.com",
- "ports": [
- 443
]
}
]
- 200
{- "name": "entrylist1",
- "version": "2021:05:16:11:09:00",
- "id": "39649209-0001-0002-0004-988278401537",
- "count": "10"
}
Delete outbound entries for an outbound entry list
Delete outbound entries for an outbound entry list
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
[- {
- "entry": "example.com",
- "ports": [
- 443
]
}
]
Retrieve the most recent outbound distribution list on the appliance(s)
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "limit": 0,
- "cursor": "string",
- "distributions": [
- {
- "distributionUuid": "string",
- "submitTime": "string",
- "status": "string",
- "applianceId": 0
}
]
}
Distribute outbound entrylists and outbound filtering configurations to the appliance(s)
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"
}
]
}
}
Retrieve the outbound filtering configuration list
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "limit": 0,
- "totalCount": 0,
- "next": "string",
- "outboundPolicies": [
- {
- "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"
]
}
}
]
}
]
}
Create an outbound filtering configuration
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"
]
}
}
]
}
Retrieve the outbound policy exceptions list
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "limit": 0,
- "nextEvaluatedKey": "string",
- "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"
]
}
}
]
}
Create an outbound policy exception
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- Payload
{- "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "source": {
- "cidrs": [
- "192.0.2.0/24",
- "198.51.100.0/24"
]
}
}
- 200
{- "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "exceptionUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
- "source": {
- "cidrs": [
- "192.0.2.0/24",
- "198.51.100.0/24"
]
}
}
Get an outbound entry list
Fetch an outbound entry list
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
- 200
{- "name": "entrylist1",
- "version": "2021:05:16:11:09:00",
- "id": "39649209-0001-0002-0004-988278401537",
- "count": "10"
}
Delete an outbound entry list
Deletes an outbound entry list with the given id. All outbound entries associated with this outbound entry list will be deleted.
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Service Unavailable
Retrieve the status of the outbound distribution job on the appliance(s)
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
}
]
}