Outbound Filtering

This is a create, read, update, delete (CRUD) API that is used to manage outbound filtering lists and configurations

Update the outbound filtering configuration

put/outbound/configurations/{outboundPolicyUuid}
Request
path Parameters
outboundPolicyUuid
required
string
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": [
    ]
}

Retrieve an outbound policy exception

get/outbound/configurations/{outboundPolicyUuid}/exceptions/{exceptionUuid}
Request
path Parameters
exceptionUuid
required
string
outboundPolicyUuid
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
  • "exceptionUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
  • "source": {
    }
}

Update an outbound policy exception

put/outbound/configurations/{outboundPolicyUuid}/exceptions/{exceptionUuid}
Request
path Parameters
exceptionUuid
required
string
outboundPolicyUuid
required
string
Request Body schema: application/json
entryListUuid
required
string

Uuid of the entry list

object (OutboundPolicyExceptionConfiguration)

Source configuration

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
  • "source": {
    }
}
Response samples
application/json
{
  • "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
  • "exceptionUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
  • "source": {
    }
}

Delete an outbound policy exception

delete/outbound/configurations/{outboundPolicyUuid}/exceptions/{exceptionUuid}
Request
path Parameters
exceptionUuid
required
string
outboundPolicyUuid
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Fetch an outbound entry lists

get/outbound/entrylists

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.

Request
query Parameters
cursor
string
limit
integer <int32> [ 1 .. 1000 ]
Default: 10
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "entryLists": [
    ],
  • "limit": "10",
  • "next": "abcd"
}

Create an outbound entry list

post/outbound/entrylists

Creates a new outbound entry list with the given name.

Request
Request Body schema: application/json
name
required
string [ 1 .. 60 ] characters [a-zA-Z0-9-_]+

Name of the outbound entry list

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "name": "entrylist1"
}
Response samples
application/json
{
  • "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

get/outbound/entrylists/{id}/entries

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.

Request
path Parameters
id
required
string

Id of the outbound entry list

Example: 39649209-0001-0002-0004-988278401537
query Parameters
cursor
string

String to paginate requests

limit
integer <int32> <= 1000
Default: 10

Number of outbound entries to fetch

Example: limit=10
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": 10,
  • "next": "abcd",
  • "entries": [
    ]
}

Create outbound entries for an outbound entry list

post/outbound/entrylists/{id}/entries

Add outbound entries to an outbound entry list

Request
path Parameters
id
required
string

Id of the outbound entry list

Example: 39649209-0001-0002-0004-988278401537
Request Body schema: application/json
Array
entry
required
string

The domain name or IP address to permit

ports
Array of integers <int32> [ 0 .. 20 ] items

List of ports for the entry

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "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/entrylists/{id}/entries

Delete outbound entries for an outbound entry list

Request
path Parameters
id
required
string

Id of the outbound entry list

Example: 39649209-0001-0002-0004-988278401537
Request Body schema: application/json
Array
entry
required
string

The domain name or IP address to permit

ports
Array of integers <int32> [ 0 .. 20 ] items

List of ports for the entry

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
[
  • {
    }
]

Retrieve the most recent outbound distribution list on the appliance(s)

get/outbound/distributions
Request
query Parameters
cursor
string
limit
integer <int32>
Default: 10
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,
  • "cursor": "string",
  • "distributions": [
    ]
}

Distribute outbound entrylists and outbound filtering configurations to the appliance(s)

post/outbound/distributions
Request
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": {
    }
}

Retrieve the outbound filtering configuration list

get/outbound/configurations
Request
query Parameters
cursor
string
limit
integer <int32>
Default: 10
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",
  • "outboundPolicies": [
    ]
}

Create an outbound filtering configuration

post/outbound/configurations
Request
Request Body schema: application/json
enabled
required
boolean

Switch of the policy

Array of objects (OutboundPolicyException)

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": [
    ]
}

Retrieve the outbound policy exceptions list

get/outbound/configurations/{outboundPolicyUuid}/exceptions
Request
path Parameters
outboundPolicyUuid
required
string
query Parameters
cursor
string
limit
integer <int32>
Default: 10
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,
  • "nextEvaluatedKey": "string",
  • "exceptions": [
    ]
}

Create an outbound policy exception

post/outbound/configurations/{outboundPolicyUuid}/exceptions
Request
path Parameters
outboundPolicyUuid
required
string
Request Body schema: application/json
entryListUuid
required
string

Uuid of the entry list

object (OutboundPolicyExceptionConfiguration)

Source configuration

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
  • "source": {
    }
}
Response samples
application/json
{
  • "entryListUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
  • "exceptionUuid": "e683094b-772f-40d4-a8be-ac4b78c5b41a",
  • "source": {
    }
}

Get an outbound entry list

get/outbound/entrylists/{id}

Fetch an outbound entry list

Request
path Parameters
id
required
string

Id of the outbound entry list

Example: 39649209-0001-0002-0004-988278401537
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "name": "entrylist1",
  • "version": "2021:05:16:11:09:00",
  • "id": "39649209-0001-0002-0004-988278401537",
  • "count": "10"
}

Delete an outbound entry list

delete/outbound/entrylists/{id}

Deletes an outbound entry list with the given id. All outbound entries associated with this outbound entry list will be deleted.

Request
path Parameters
id
required
string

Id of the outbound entry list

Example: 39649209-0001-0002-0004-988278401537
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Retrieve the status of the outbound distribution job on the appliance(s)

get/outbound/distributions/{outboundDistributionId}
Request
path Parameters
outboundDistributionId
required
string
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": [
    ]
}