Cloudfeeds Open API

Cloudfeeds Public API

Default request content-types: application/json, multipart/form-data
Default response content-types: application/json
Schemes: http

Summary

Tag: cc_one

Operation Description
POST /cc/param/{feed_content_type}/{feed_name}
GET /cc/param/{feed_content_type}/{feed_name}
PATCH /cc/param/{feed_content_type}/{feed_name}
DELETE /cc/param/{feed_content_type}/{feed_name}

Tag: cc_n

Operation Description
POST /cc/file/{feed_content_type}/{feed_name}
GET /cc/file/{feed_content_type}/{feed_name}
PATCH /cc/file/{feed_content_type}/{feed_name}
DELETE /cc/file/{feed_content_type}/{feed_name}

Tag: blwl_one

Operation Description
POST /{feed_type}/param/{feed_content_type}/{feed_name}
GET /{feed_type}/param/{feed_content_type}/{feed_name}
PATCH /{feed_type}/param/{feed_content_type}/{feed_name}
DELETE /{feed_type}/param/{feed_content_type}/{feed_name}

Tag: blwl_n

Operation Description
POST /{feed_type}/file/{feed_content_type}/{feed_name}
GET /{feed_type}/file/{feed_content_type}/{feed_name}
PATCH /{feed_type}/file/{feed_content_type}/{feed_name}
DELETE /{feed_type}/file/{feed_content_type}/{feed_name}

Tag: default

Operation Description
GET /ping

Ping the API to determine if it is alive.

Security

Bearer

name: Authorization
in: header

Paths

DELETE /cc/file/{feed_content_type}/{feed_name}

Tags: cc_n

Delete given server in the feed or the entire feed.

multipart/form-data

feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
file

csv file, with a single column for server.

formData file #/parameters/blwl_file_form
failOnError

Whether to partially process the file in case of parsing errors.

formData boolean true #/parameters/failOnError_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

GET /cc/file/{feed_content_type}/{feed_name}

Tags: cc_n

The feed processing engine, periodically stores the status of processing or intermediary errors. This api retrives that status message

feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

200 OK

Get the processing status of the feed.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

PATCH /cc/file/{feed_content_type}/{feed_name}

Tags: cc_n

Updates an IP/URL/DOMAIN in a given feed with a threat level between 1-10.

multipart/form-data

feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
file

csv file, with columns

formData file #/parameters/cc_file_form
failOnError

Whether to partially process the file in case of parsing errors.

formData boolean true #/parameters/failOnError_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

POST /cc/file/{feed_content_type}/{feed_name}

Tags: cc_n

Inject an IP/URL/DOMAIN into CC feed with a threat level between 1-10. Subsequent POST with same feed name will throw an error.

multipart/form-data

feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
file

csv file, with columns

formData file #/parameters/cc_file_form
failOnError

Whether to partially process the file in case of parsing errors.

formData boolean true #/parameters/failOnError_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

DELETE /cc/param/{feed_content_type}/{feed_name}

Tags: cc_one

Delete given server in the feed or the entire feed. Pass server name as *, to delete the entire feed.

multipart/form-data

feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
server

IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 are supported.

formData string (1 to 128 chars) #/parameters/server_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

GET /cc/param/{feed_content_type}/{feed_name}

Tags: cc_one

The feed processing engine, periodically stores the status of processing or intermediary errors. This api retrives that status message

feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

200 OK

Get the processing status of the feed.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

PATCH /cc/param/{feed_content_type}/{feed_name}

Tags: cc_one

Updates an IP/URL/DOMAIN in a given feed with a threat level between 1-10.

multipart/form-data

feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
server

IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 are supported.

formData string (1 to 128 chars) #/parameters/server_form
threat_level

Threat level, ranging between 1-10.

formData integer , { x ∈ ℤ | 1 ≤ x ≤ 10 } #/parameters/tl_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

POST /cc/param/{feed_content_type}/{feed_name}

Tags: cc_one

Inject an IP/URL/DOMAIN into CC feed with a threat level between 1-10. Subsequent POST with same feed name will throw an error.

multipart/form-data

feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
server

IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 are supported.

formData string (1 to 128 chars) #/parameters/server_form
threat_level

Threat level, ranging between 1-10.

formData integer , { x ∈ ℤ | 1 ≤ x ≤ 10 } #/parameters/tl_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer
Ping the API to determine if it is alive.

GET /ping

Uses default content-types: application/json

200 OK

Ping succeeded.

DELETE /{feed_type}/file/{feed_content_type}/{feed_name}

Tags: blwl_n

Delete given server in the feed or the entire feed.

multipart/form-data

feed_type

Type of feed. Blacklist or Whitelist.

path string , x ∈ { whitelist , blacklist } #/parameters/feed_type_path
feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
file

csv file, with a single column for server.

formData file #/parameters/blwl_file_form
failOnError

Whether to partially process the file in case of parsing errors.

formData boolean true #/parameters/failOnError_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

GET /{feed_type}/file/{feed_content_type}/{feed_name}

Tags: blwl_n

The feed processing engine, periodically stores the status of processing or intermediary errors. This api retrives that status message

feed_type

Type of feed. Blacklist or Whitelist.

path string , x ∈ { whitelist , blacklist } #/parameters/feed_type_path
feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

200 OK

Get the processing status of the feed.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

PATCH /{feed_type}/file/{feed_content_type}/{feed_name}

Tags: blwl_n

Updates an IP/URL/DOMAIN in a given feed.

multipart/form-data

feed_type

Type of feed. Blacklist or Whitelist.

path string , x ∈ { whitelist , blacklist } #/parameters/feed_type_path
feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
file

csv file, with a single column for server.

formData file #/parameters/blwl_file_form
failOnError

Whether to partially process the file in case of parsing errors.

formData boolean true #/parameters/failOnError_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

POST /{feed_type}/file/{feed_content_type}/{feed_name}

Tags: blwl_n

Inject an IP/URL/DOMAIN into BL or WL feed. Subsequent POST with same feed name will throw an error.

multipart/form-data

feed_type

Type of feed. Blacklist or Whitelist.

path string , x ∈ { whitelist , blacklist } #/parameters/feed_type_path
feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
file

csv file, with a single column for server.

formData file #/parameters/blwl_file_form
failOnError

Whether to partially process the file in case of parsing errors.

formData boolean true #/parameters/failOnError_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

DELETE /{feed_type}/param/{feed_content_type}/{feed_name}

Tags: blwl_one

Delete given server in the feed or the entire feed. Pass server name as *, to delete the entire feed.

multipart/form-data

feed_type

Type of feed. Blacklist or Whitelist.

path string , x ∈ { whitelist , blacklist } #/parameters/feed_type_path
feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
server

IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 are supported.

formData string (1 to 128 chars) #/parameters/server_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

GET /{feed_type}/param/{feed_content_type}/{feed_name}

Tags: blwl_one

The feed processing engine, periodically stores the status of processing or intermediary errors. This api retrives that status message

feed_type

Type of feed. Blacklist or Whitelist.

path string , x ∈ { whitelist , blacklist } #/parameters/feed_type_path
feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

200 OK

Get the processing status of the feed.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

PATCH /{feed_type}/param/{feed_content_type}/{feed_name}

Tags: blwl_one

Updates an IP/URL/DOMAIN in a given feed.

multipart/form-data

feed_type

Type of feed. Blacklist or Whitelist.

path string , x ∈ { whitelist , blacklist } #/parameters/feed_type_path
feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
server

IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 are supported.

formData string (1 to 128 chars) #/parameters/server_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

404 Not Found

Resource not found

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

POST /{feed_type}/param/{feed_content_type}/{feed_name}

Tags: blwl_one

Inject an IP/URL/DOMAIN into BL or WL feed. Subsequent POST with same feed name will throw an error.

multipart/form-data

feed_type

Type of feed. Blacklist or Whitelist.

path string , x ∈ { whitelist , blacklist } #/parameters/feed_type_path
feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain } #/parameters/feed_content_type_path
feed_name

Name of a feed.

path string (8 to 64 chars) #/parameters/feed_name_path
server

IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 are supported.

formData string (1 to 128 chars) #/parameters/server_form
Authorization header string #/parameters/auth_header
X-Forwarded-For header string #/parameters/forward_header

Uses default content-types: application/json

202 Accepted

The request has been accepted for processing.

request_id: string

Unique identifier of this request. Used for logs on the server side.

400 Bad Request

Request parameters are invalid

401 Unauthorized

Invalid/Expired API key

403 Forbidden

Access denied for this API key

409 Conflict

Request cannot be completed due to conflict.

422 Unprocessable Entity

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429 Too Many Requests

Client has sent too many requests in a given amount of time, api quota exceeded

500 Internal Server Error

Internal server error

503 Service Unavailable

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Bearer

Parameter definitions

server_form server

IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 are supported.

formData string (1 to 128 chars)
tl_form threat_level

Threat level, ranging between 1-10.

formData integer , { x ∈ ℤ | 1 ≤ x ≤ 10 }
blwl_file_form file

csv file, with a single column for server.

formData file
cc_file_form file

csv file, with columns

formData file
failOnError_form failOnError

Whether to partially process the file in case of parsing errors.

formData boolean true
feed_type_path feed_type

Type of feed. Blacklist or Whitelist.

path string , x ∈ { whitelist , blacklist }
feed_content_type_path feed_content_type

Content type of the feed. Could be one of ip, url or domain.

path string , x ∈ { ip , url , domain }
feed_name_path feed_name

Name of a feed.

path string (8 to 64 chars)
auth_header Authorization header string
forward_header X-Forwarded-For header string

Response definitions

400

Request parameters are invalid

401

Invalid/Expired API key

403

Access denied for this API key

409

Request cannot be completed due to conflict.

422

Unprocessable Entity. Input is syntactically correct but semantically incorrect.

429

Client has sent too many requests in a given amount of time, api quota exceeded

500

Internal server error

503

Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.

Schema definitions

AuthenticatedUser: object

Internal structure describing an authorized OpenAPI user.

TenantID: string

Sky ATP Tenant ID.

TokenID: string

Sky ATP OpenAPI tokenID.

AuthHeader: string

Authorization Bearer token.

XForwardFor: string

Header describing the request originating IP address.

CustomerPortalError: object

Internal structure describing an error returned by Sky ATP Portal

Error: string

Short Error Description

ErrorDesc: string

Detailed Error Description

Success: boolean

Boolean whether request succeeded

ErrorCode: integer

HTTP Response code

error_data: object

Standard error response data structure for everything that is not ok.

request_id: string

Unique identifier of this request. Used for logs on the server side.

err_id: string

Text representation of error code.

message: string

Short error description.

details: string

Long error description. Must not be used for error handling purposes.

valid_response: object

Standard error response data structure for everything that is ok.

request_id: string

Unique identifier of this request. Used for logs on the server side.

message: string

Message describing processing status.