IP Filter Open API

IP Filter Public API
More information: https://threat-api.sky.junipersecurity.net
Contact Info: Sky-ATP-support-info@juniper.net
Version: 1.0
BasePath:/v1/cloudfeeds
Juniper Networks Inc
http://cloudfeeds.junipersecurity.net

Access

  1. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

Default

Ipf_n

Ipf_one

Default

Up
get /ping
Ping the API to determine if it is alive. (ping)

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ping succeeded.

Ipf_n

Up
delete /ipfilter/file/{feed_name}
(delIpfFile)
Delete all given IPs in the feed.

Path parameters

feed_name (required)
Path Parameter Name of a feed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Form parameters

file (required)
Form Parameter csv file, with a single column for IP.
failOnError (optional)
Form Parameter Whether to partially process the file in case of parsing errors. default: true

Return type

inline_response_202

Example data

Content-Type: application/json
{
  "request_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted for processing. inline_response_202

400

Request parameters are invalid error_data

401

Invalid/Expired API key error_data

403

Access denied for this API key error_data

404

Resource not found error_data

409

Request cannot be completed due to conflict. error_data

422

Unprocessable Entity. Input is syntactically correct but semantically incorrect. error_data

429

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

500

Internal server error error_data

503

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

Up
get /ipfilter/file/{feed_name}
(getIpfFile)
The feed processing engine, periodically stores the status of processing or intermediary errors. This api retrives that status message

Path parameters

feed_name (required)
Path Parameter Name of a feed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

valid_response

Example data

Content-Type: application/json
{
  "message" : "aeiou",
  "request_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Get the processing status of the feed. valid_response

400

Request parameters are invalid error_data

401

Invalid/Expired API key error_data

403

Access denied for this API key error_data

404

Resource not found error_data

409

Request cannot be completed due to conflict. error_data

422

Unprocessable Entity. Input is syntactically correct but semantically incorrect. error_data

429

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

500

Internal server error error_data

503

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

Up
patch /ipfilter/file/{feed_name}
(patchIpfFile)
Updates all given IPs in the mentioned Ipfilter feed until the 10000 limit reach.

Path parameters

feed_name (required)
Path Parameter Name of a feed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Form parameters

file (required)
Form Parameter csv file, with a single column for IP.
failOnError (optional)
Form Parameter Whether to partially process the file in case of parsing errors. default: true

Return type

inline_response_202

Example data

Content-Type: application/json
{
  "request_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted for processing. inline_response_202

400

Request parameters are invalid error_data

401

Invalid/Expired API key error_data

403

Access denied for this API key error_data

404

Resource not found error_data

409

Request cannot be completed due to conflict. error_data

422

Unprocessable Entity. Input is syntactically correct but semantically incorrect. error_data

429

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

500

Internal server error error_data

503

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

Up
post /ipfilter/file/{feed_name}
(postIpfFile)
Inject all given IPs into the mentioned Ipfilter feed. Subsequent POST with same feed name will throw an error unless overwrite_content is enabled.

Path parameters

feed_name (required)
Path Parameter Name of a feed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Form parameters

file (required)
Form Parameter csv file, with a single column for IP.
overwrite_content (optional)
Form Parameter Whether to over write feed data. If true (enabled) then over write the existing feed. default: false.
failOnError (optional)
Form Parameter Whether to partially process the file in case of parsing errors. default: true

Return type

inline_response_202

Example data

Content-Type: application/json
{
  "request_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted for processing. inline_response_202

400

Request parameters are invalid error_data

401

Invalid/Expired API key error_data

403

Access denied for this API key error_data

409

Request cannot be completed due to conflict. error_data

422

Unprocessable Entity. Input is syntactically correct but semantically incorrect. error_data

429

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

500

Internal server error error_data

503

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

Ipf_one

Up
delete /ipfilter/param/{feed_name}
(delIpfParam)
Delete given IP in the feed or the entire feed. Pass server name as * to delete the entire feed.

Path parameters

feed_name (required)
Path Parameter Name of a feed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Form parameters

server (required)
Form Parameter Only valid IP (IP, IP range or CIDR) allowed. IPv4 and IPv6 are supported.

Return type

inline_response_202

Example data

Content-Type: application/json
{
  "request_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted for processing. inline_response_202

400

Request parameters are invalid error_data

401

Invalid/Expired API key error_data

403

Access denied for this API key error_data

404

Resource not found error_data

409

Request cannot be completed due to conflict. error_data

422

Unprocessable Entity. Input is syntactically correct but semantically incorrect. error_data

429

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

500

Internal server error error_data

503

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

Up
get /ipfilter/param/{feed_name}
(getIpfParam)
The feed processing engine, periodically stores the status of processing or intermediary errors. This api retrives that status message

Path parameters

feed_name (required)
Path Parameter Name of a feed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

valid_response

Example data

Content-Type: application/json
{
  "message" : "aeiou",
  "request_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Get the processing status of the feed. valid_response

400

Request parameters are invalid error_data

401

Invalid/Expired API key error_data

403

Access denied for this API key error_data

404

Resource not found error_data

409

Request cannot be completed due to conflict. error_data

422

Unprocessable Entity. Input is syntactically correct but semantically incorrect. error_data

429

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

500

Internal server error error_data

503

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

Up
patch /ipfilter/param/{feed_name}
(patchIpfParam)
Updates an IP in a given Ipfilter feed.

Path parameters

feed_name (required)
Path Parameter Name of a feed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Form parameters

server (required)
Form Parameter Only valid IP (IP, IP range or CIDR) allowed. IPv4 and IPv6 are supported.

Return type

inline_response_202

Example data

Content-Type: application/json
{
  "request_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted for processing. inline_response_202

400

Request parameters are invalid error_data

401

Invalid/Expired API key error_data

403

Access denied for this API key error_data

404

Resource not found error_data

409

Request cannot be completed due to conflict. error_data

422

Unprocessable Entity. Input is syntactically correct but semantically incorrect. error_data

429

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

500

Internal server error error_data

503

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

Up
post /ipfilter/param/{feed_name}
(postIpfParam)
Inject an IP into IPFilter feed. Subsequent POST with same feed name will throw an error unless overwrite_content is enabled.

Path parameters

feed_name (required)
Path Parameter Name of a feed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Form parameters

server (required)
Form Parameter Only valid IP (IP, IP range or CIDR) allowed. IPv4 and IPv6 are supported.
overwrite_content (optional)
Form Parameter Whether to over write feed data. If true (enabled) then over write the existing feed. default: false.

Return type

inline_response_202

Example data

Content-Type: application/json
{
  "request_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted for processing. inline_response_202

400

Request parameters are invalid error_data

401

Invalid/Expired API key error_data

403

Access denied for this API key error_data

409

Request cannot be completed due to conflict. error_data

422

Unprocessable Entity. Input is syntactically correct but semantically incorrect. error_data

429

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

500

Internal server error error_data

503

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

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AuthenticatedUser
  2. CustomerPortalError
  3. error_data
  4. inline_response_202
  5. valid_response

AuthenticatedUser - Up

Internal structure describing an authorized OpenAPI user.
TenantID (optional)
String Sky ATP Tenant ID.
TokenID (optional)
String Sky ATP OpenAPI tokenID.
AuthHeader (optional)
String Authorization Bearer token.
XForwardFor (optional)
String Header describing the request originating IP address.

CustomerPortalError - Up

Internal structure describing an error returned by Sky ATP Portal
Error (optional)
String Short Error Description
ErrorDesc (optional)
String Detailed Error Description
Success (optional)
Boolean Boolean whether request succeeded
ErrorCode (optional)
Integer HTTP Response code

error_data - Up

Standard error response data structure for everything that is not ok.
request_id (optional)
String Unique identifier of this request. Used for logs on the server side.
err_id (optional)
String Text representation of error code.
message (optional)
String Short error description.
details (optional)
String Long error description. Must not be used for error handling purposes.

inline_response_202 - Up

request_id (optional)
String Unique identifier of this request. Used for logs on the server side.

valid_response - Up

Standard error response data structure for everything that is ok.
request_id (optional)
String Unique identifier of this request. Used for logs on the server side.
message (optional)
String Message describing processing status.