Cloudfeeds Public API
| Operation | Description |
|---|---|
| GET /ping | Ping the API to determine if it is alive. |
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
Get the processing status of the feed.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
Get the processing status of the feed.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
Uses default content-types: application/json
Ping succeeded.
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
Get the processing status of the feed.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
Get the processing status of the feed.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Resource not found
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
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
The request has been accepted for processing.
Unique identifier of this request. Used for logs on the server side.
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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 |
Request parameters are invalid
Invalid/Expired API key
Access denied for this API key
Request cannot be completed due to conflict.
Unprocessable Entity. Input is syntactically correct but semantically incorrect.
Client has sent too many requests in a given amount of time, api quota exceeded
Internal server error
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.
Internal structure describing an authorized OpenAPI user.
Sky ATP Tenant ID.
Sky ATP OpenAPI tokenID.
Authorization Bearer token.
Header describing the request originating IP address.
Internal structure describing an error returned by Sky ATP Portal
Short Error Description
Detailed Error Description
Boolean whether request succeeded
HTTP Response code
Standard error response data structure for everything that is not ok.
Unique identifier of this request. Used for logs on the server side.
Text representation of error code.
Short error description.
Long error description. Must not be used for error handling purposes.