{ "consumes": [ "application/json", "multipart/form-data" ], "produces": [ "application/json" ], "schemes": [ "http" ], "swagger": "2.0", "info": { "description": "Threat Intelligence Public API", "title": "Threat Intelligence Open API", "contact": { "name": "SkyATP support", "url": "https://www.juniper.net/documentation/en_US/release-independent/sky-atp/information-products/pathway-pages/index.html" }, "license": { "name": "Juniper Networks Inc", "url": "https://www.juniper.net/documentation/en_US/release-independent/sky-atp/topics/topic-map/sky-atp-license-mgmt.html" }, "version": "2.0" }, "basePath": "/v2/cloudfeeds", "paths": { "/DNS/file/{feed_name}": { "get": { "description": "Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.", "tags": [ "dns_n" ], "operationId": "get_dns_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "200": { "description": "Get the processing status of the feed.", "schema": { "$ref": "#/definitions/valid_response" } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "put": { "description": "Fully replaces the content of a DNS file feed. Creates the feed if it does not exist.", "consumes": [ "multipart/form-data" ], "tags": [ "dns_n" ], "operationId": "put_dns_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/cc_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "post": { "description": "Inject DOMAIN into CC feed with a threat level between 1-10. Subsequent POST with same feed name will throw an error.", "consumes": [ "multipart/form-data" ], "tags": [ "dns_n" ], "operationId": "post_dns_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/cc_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "delete": { "description": "Delete the provided entry from the feed. If no DOMAIN is provided, the entire feed will be deleted.", "consumes": [ "multipart/form-data" ], "tags": [ "dns_n" ], "operationId": "del_dns_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "patch": { "description": "Updates DOMAIN in a given feed with a threat level between 1-10.", "consumes": [ "multipart/form-data" ], "tags": [ "dns_n" ], "operationId": "patch_dns_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/cc_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } } }, "/DNS/param/{feed_name}": { "get": { "description": "Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.", "tags": [ "dns_one" ], "operationId": "get_dns_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "200": { "description": "Get the processing status of the feed.", "schema": { "$ref": "#/definitions/valid_response" } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "post": { "description": "Inject DOMAIN into DNS feed with a threat level between 1-10. Subsequent POST with same feed name will throw an error.", "consumes": [ "multipart/form-data" ], "tags": [ "dns_one" ], "operationId": "post_dns_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/tl_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "delete": { "description": "Delete the provided entry from the feed. If no DOMAIN is provided, the entire feed will be deleted. Pass server name as *, to delete the entire feed.", "consumes": [ "multipart/form-data" ], "tags": [ "dns_one" ], "operationId": "del_dns_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "patch": { "description": "Updates DOMAIN in a given feed with a threat level between 1-10.", "consumes": [ "multipart/form-data" ], "tags": [ "dns_one" ], "operationId": "patch_dns_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/tl_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } } }, "/cc/file/{feed_content_type}/{feed_name}": { "get": { "description": "Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.", "tags": [ "cc_n" ], "operationId": "get_cc_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "200": { "description": "Get the processing status of the feed.", "schema": { "$ref": "#/definitions/valid_response" } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "put": { "description": "Fully replaces the content of a CC file feed. Creates the feed if it does not exist.", "consumes": [ "multipart/form-data" ], "tags": [ "cc_n" ], "operationId": "put_cc_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/cc_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "post": { "description": "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.", "consumes": [ "multipart/form-data" ], "tags": [ "cc_n" ], "operationId": "post_cc_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/cc_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "delete": { "description": "Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted.", "consumes": [ "multipart/form-data" ], "tags": [ "cc_n" ], "operationId": "del_cc_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "patch": { "description": "Updates an IP/URL/DOMAIN in a given feed with a threat level between 1-10.", "consumes": [ "multipart/form-data" ], "tags": [ "cc_n" ], "operationId": "patch_cc_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/cc_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } } }, "/cc/param/{feed_content_type}/{feed_name}": { "get": { "description": "Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.", "tags": [ "cc_one" ], "operationId": "get_cc_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "200": { "description": "Get the processing status of the feed.", "schema": { "$ref": "#/definitions/valid_response" } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "post": { "description": "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.", "consumes": [ "multipart/form-data" ], "tags": [ "cc_one" ], "operationId": "post_cc_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/tl_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "delete": { "description": "Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted. Pass server name as *, to delete the entire feed.", "consumes": [ "multipart/form-data" ], "tags": [ "cc_one" ], "operationId": "del_cc_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "patch": { "description": "Updates an IP/URL/DOMAIN in a given feed with a threat level between 1-10.", "consumes": [ "multipart/form-data" ], "tags": [ "cc_one" ], "operationId": "patch_cc_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/tl_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } } }, "/ipfilter/file/{feed_name}": { "get": { "description": "Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.", "tags": [ "ipf_n" ], "operationId": "get_ipf_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "200": { "description": "Get the processing status of the feed.", "schema": { "$ref": "#/definitions/valid_response" } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "put": { "description": "Fully replaces the content of an IPFilter file feed. Creates the feed if it does not exist.", "consumes": [ "multipart/form-data" ], "tags": [ "ipf_n" ], "operationId": "put_ipf_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "post": { "description": "Inject an IP into Ipfilter feed. Subsequent POST with same feed name will throw an error unless overwrite_content is enabled.", "consumes": [ "multipart/form-data" ], "tags": [ "ipf_n" ], "operationId": "post_ipf_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/overwrite_content_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "delete": { "description": "Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted.", "consumes": [ "multipart/form-data" ], "tags": [ "ipf_n" ], "operationId": "del_ipf_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "patch": { "description": "Updates an IP in a given Ipfilter feed.", "consumes": [ "multipart/form-data" ], "tags": [ "ipf_n" ], "operationId": "patch_ipf_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } } }, "/ipfilter/param/{feed_name}": { "get": { "description": "Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.", "tags": [ "ipf_one" ], "operationId": "get_ipf_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "200": { "description": "Get the processing status of the feed.", "schema": { "$ref": "#/definitions/valid_response" } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "post": { "description": "Inject an IP into IPFilter feed. Subsequent POST with same feed name will throw an error unless overwrite_content is enabled.", "consumes": [ "multipart/form-data" ], "tags": [ "ipf_one" ], "operationId": "post_ipf_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/overwrite_content_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "delete": { "description": "Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted. Pass server name as *, to delete the entire feed.", "consumes": [ "multipart/form-data" ], "tags": [ "ipf_one" ], "operationId": "del_ipf_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "patch": { "description": "Updates an IP in a given Ipfilter feed.", "consumes": [ "multipart/form-data" ], "tags": [ "ipf_one" ], "operationId": "patch_ipf_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } } }, "/ping": { "get": { "summary": "Ping the API to determine if it is alive.", "operationId": "ping", "responses": { "200": { "description": "Ping succeeded." } } } }, "/{feed_type}/file/{feed_content_type}/{feed_name}": { "get": { "description": "Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.", "tags": [ "blwl_n" ], "operationId": "get_blwl_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_type_path" }, { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "200": { "description": "Get the processing status of the feed.", "schema": { "$ref": "#/definitions/valid_response" } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "put": { "description": "Fully replaces the content of a BL/WL file feed. Creates the feed if it does not exist.", "consumes": [ "multipart/form-data" ], "tags": [ "blwl_n" ], "operationId": "put_blwl_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_type_path" }, { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "post": { "description": "Inject an IP/URL/DOMAIN into BL or WL feed. Subsequent POST with same feed name will throw an error.", "consumes": [ "multipart/form-data" ], "tags": [ "blwl_n" ], "operationId": "post_blwl_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_type_path" }, { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "delete": { "description": "Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted.", "consumes": [ "multipart/form-data" ], "tags": [ "blwl_n" ], "operationId": "del_blwl_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_type_path" }, { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "patch": { "description": "Updates an IP/URL/DOMAIN in a given feed.", "consumes": [ "multipart/form-data" ], "tags": [ "blwl_n" ], "operationId": "patch_blwl_file", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_type_path" }, { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/blwl_file_form" }, { "$ref": "#/parameters/failOnError_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } } }, "/{feed_type}/param/{feed_content_type}/{feed_name}": { "get": { "description": "Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.", "tags": [ "blwl_one" ], "operationId": "get_blwl_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_type_path" }, { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "200": { "description": "Get the processing status of the feed.", "schema": { "$ref": "#/definitions/valid_response" } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "post": { "description": "Inject an IP/URL/DOMAIN into BL or WL feed. Subsequent POST with same feed name will throw an error.", "consumes": [ "multipart/form-data" ], "tags": [ "blwl_one" ], "operationId": "post_blwl_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_type_path" }, { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "delete": { "description": "Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted. Pass server name as *, to delete the entire feed.", "consumes": [ "multipart/form-data" ], "tags": [ "blwl_one" ], "operationId": "del_blwl_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_type_path" }, { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } }, "patch": { "description": "Updates an IP/URL/DOMAIN in a given feed.", "consumes": [ "multipart/form-data" ], "tags": [ "blwl_one" ], "operationId": "patch_blwl_param", "security": [ { "Bearer": [] } ], "parameters": [ { "$ref": "#/parameters/feed_type_path" }, { "$ref": "#/parameters/feed_content_type_path" }, { "$ref": "#/parameters/feed_name_path" }, { "$ref": "#/parameters/server_form" }, { "$ref": "#/parameters/auth_header" }, { "$ref": "#/parameters/forward_header" } ], "responses": { "202": { "description": "The request has been accepted for processing.", "schema": { "type": "object", "properties": { "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } } } } }, "definitions": { "AuthenticatedUser": { "description": "Internal structure describing an authorized OpenAPI user.", "type": "object", "properties": { "AuthHeader": { "description": "Authorization Bearer token.", "type": "string" }, "TenantID": { "description": "Sky ATP Tenant ID.", "type": "string" }, "TokenID": { "description": "Sky ATP OpenAPI tokenID.", "type": "string" }, "XForwardFor": { "description": "Header describing the request originating IP address.", "type": "string" } } }, "CustomerPortalError": { "description": "Internal structure describing an error returned by Sky ATP Portal", "type": "object", "properties": { "Error": { "description": "Short Error Description", "type": "string" }, "ErrorCode": { "description": "HTTP Response code", "type": "integer" }, "ErrorDesc": { "description": "Detailed Error Description", "type": "string" }, "Success": { "description": "Boolean whether request succeeded", "type": "boolean" } } }, "error_data": { "description": "Standard error response data structure for everything that is not ok.", "type": "object", "properties": { "details": { "description": "Long error description. Must not be used for error handling purposes.", "type": "string" }, "err_id": { "description": "Text representation of error code.", "type": "string" }, "message": { "description": "Short error description.", "type": "string" }, "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } }, "valid_response": { "description": "Standard error response data structure for everything that is ok.", "type": "object", "properties": { "message": { "description": "Message describing processing status.", "type": "string" }, "request_id": { "description": "Unique identifier of this request. Used for logs on the server side.", "type": "string", "pattern": "^[\\\\w\\\\-]{4,64}$" } } } }, "parameters": { "auth_header": { "type": "string", "name": "Authorization", "in": "header", "required": true }, "blwl_file_form": { "type": "file", "description": "csv file, with a single column for server.", "name": "file", "in": "formData", "required": true }, "cc_file_form": { "type": "file", "description": "csv file, with columns \u003cserver, threat_level\u003e", "name": "file", "in": "formData", "required": true }, "failOnError_form": { "type": "boolean", "default": true, "description": "Whether to partially process the file in case of parsing errors.", "name": "failOnError", "in": "formData" }, "feed_content_type_path": { "enum": [ "ip", "url", "domain" ], "type": "string", "description": "Content type of the feed. Could be one of ip, url or domain.", "name": "feed_content_type", "in": "path", "required": true }, "feed_name_path": { "maxLength": 64, "minLength": 8, "pattern": "^[a-zA-Z0-9\\\\_]{8,64}$", "type": "string", "description": "Name of a feed.", "name": "feed_name", "in": "path", "required": true }, "feed_type_path": { "enum": [ "whitelist", "blacklist" ], "type": "string", "description": "Type of feed. Blacklist or Whitelist.", "name": "feed_type", "in": "path", "required": true }, "forward_header": { "type": "string", "name": "X-Forwarded-For", "in": "header" }, "overwrite_content_form": { "type": "boolean", "default": false, "description": "Deprecated for bulk replace. Use PUT file endpoints for full content replace; this flag only applies to legacy POST IPFilter behavior.", "name": "overwrite_content", "in": "formData" }, "server_form": { "maxLength": 128, "minLength": 1, "type": "string", "description": "IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.", "name": "server", "in": "formData", "required": true }, "tl_form": { "maximum": 10, "minimum": 1, "type": "integer", "description": "Threat level, ranging between 1-10.", "name": "threat_level", "in": "formData", "required": true } }, "responses": { "400": { "description": "Request parameters are invalid", "schema": { "$ref": "#/definitions/error_data" } }, "401": { "description": "Invalid/Expired API key", "schema": { "$ref": "#/definitions/error_data" } }, "403": { "description": "Access denied for this API key", "schema": { "$ref": "#/definitions/error_data" } }, "409": { "description": "Request cannot be completed due to conflict.", "schema": { "$ref": "#/definitions/error_data" } }, "422": { "description": "Unprocessable Entity. Input is syntactically correct but semantically incorrect.", "schema": { "$ref": "#/definitions/error_data" } }, "429": { "description": "Client has sent too many requests in a given amount of time, API quota exceeded", "schema": { "$ref": "#/definitions/error_data" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/error_data" } }, "503": { "description": "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": { "$ref": "#/definitions/error_data" } } }, "securityDefinitions": { "Bearer": { "type": "APIKey", "name": "Authorization", "in": "header" } } }