{"attachments":{"all_attachments":null,"all_attachments_api":null,"topic_attachments":[{"filename":"cloud-v1-api.yaml","url":"https://docs-cybersec-be.thalesgroup.com/bundle/api-docs/attach/cloud-v1-api.yaml","url_api":"https://docs-cybersec-be.thalesgroup.com/api/bundle/api-docs/topicattach/cloud-v1-api-definition.htm?file=cloud-v1-api.yaml"}]},"available_languages":["enus"],"breadcrumbs":[],"breadcrumbs_html":"Imperva API Documentation\n\n\nCloud Application Security v1/v3 API Definition\n","bundle_id":"api-docs","bundle_landing_page":"api/api-overview.htm","bundle_subtitle":null,"bundle_title":"Imperva API Documentation","dates":{"Added on":"2026-03-29T09:01:52.989896Z","Created on":"2026-03-29T00:00:00Z","Initial upload":"2025-04-28T08:19:09.075547Z","Updated on":"2025-08-14T00:00:00Z"},"dislike_url":"https://docs-cybersec-be.thalesgroup.com/dislike/5602592","dislikes":0,"es_archived_content":false,"is_in_fav":false,"is_liked":null,"is_watched":false,"keywords":[" API Reference Public Public API Reference"],"labels":[{"aliases":["access-public"],"hidden":false,"isSubjectHead":false,"key":"Public","navtitle":"Public","outputclasses":[],"subjectHeadId":"accessid","subjectheadNavtitle":"Access","visibility":"show-facet"},{"aliases":["doc-api-definition","doc-api-reference"],"hidden":false,"isSubjectHead":false,"key":"doc-api","navtitle":"API Reference","outputclasses":[],"subjectHeadId":"documentationtypeid","subjectheadNavtitle":"Document Type","visibility":"refine-search"},{"aliases":["source-product"],"hidden":false,"isSubjectHead":false,"key":"zdoc","navtitle":"Documentation","outputclasses":[],"subjectHeadId":"sourcetypeid","subjectheadNavtitle":"Source Type","visibility":"show-facet"}],"labels_text":"Access > Public; Document Type > API Reference; Source Type > Documentation","like_url":"https://docs-cybersec-be.thalesgroup.com/like/5602592","likes":0,"metadata":{"apiType":"definition","config-location":"cloud-v1-api.yaml","description":"Cloud Application Security API Imperva provides customers and partners with the ability to manage accounts and sites via an API. For more information, see Cloud Application Security API Reference . Version: 1.0 Imperva License Agreement. http://www.imperva.com/other/license_agreement.asp Access APIKey KeyParamName:x-API-Id KeyInQuery:false","display-type":"swagger-spec","outputclasses":"","specType":"swagger"},"page_id":"cloud-v1-api-definition.htm","page_key":5602592,"preprocessed_PDF":null,"rating":null,"read_time_data":{"char_count":374456,"img_count":0,"read_time":162,"video_links":[""],"word_count":42848},"related_links":[],"searchtitle":"Cloud Application Security v1/v3 API Definition","title":"Cloud Application Security v1/v3 API Definition","topic_cluster":{"clustered_by":{"enabled":true,"primary_key":"productversionid","primary_sort":"top-down","secondary_key":"skilljaraccessid","secondary_sort":"top-down","type":"subjecthead"},"clustered_labels":["productversionid","skilljaraccessid"],"clustered_topics":[],"clustering_title":" - "},"topic_html":"

Cloud Application Security API

Imperva provides customers and partners with the ability to manage accounts and sites via an API.\nFor more information, see Cloud Application Security API Reference.
Version: 1.0
Imperva License Agreement.
http://www.imperva.com/other/license_agreement.asp

Access

    \n
  1. APIKey KeyParamName:x-API-Id KeyInQuery:false KeyInHeader:true
    2. \n
  2. APIKey KeyParamName:x-API-Key KeyInQuery:false KeyInHeader:true
    3. \n

Methods

Models

Table of Contents

AccountManagement

DDoSForNetworksTestAlerts

DDoSProtectionForIndividualIPs

DDoSProtectionPolicyVisibility

Integrations

LoginProtect

SiteManagement

TrafficStatisticsAndLogs

WAFLogSetup

AccountManagement

\n
\n \n 
post /api/prov/v1/accounts/add
\n
Add a new managed account (addAccount)
\n
Available for Reseller accounts only
Use this operation to add a new account that should be managed by the account of the API client (the parent account). The new account will be configured according to the preferences set for the parent account by Imperva.\nDepending on these preferences, an activation e-mail will be sent to the specified e-mail address. The user responds to the activation e-mail, selects a password, and can then log directly into the Imperva console. The same e-mail address can also be used to send system notifications to the account. The new account is identified by a numeric value as provided by Imperva in the response in the field account_id.
\n\n\n\n\n\n

Query parameters

\n
\n
email (required)
\n \n
Query Parameter — Email address. For example: "joe@example.com".
parent_id (optional)
\n \n
Query Parameter — The newly created account's parent id. If not specified, the invoking account will be assigned as the parent. format: int64
name (optional)
\n \n
Query Parameter — The account owner's name. For example: "John Doe".
plan_id (optional)
\n \n
Query Parameter — An identifier of the plan to assign to the new account. For example, ent100 for the Enterprise 100 plan.<br/>Example values:<br/>ent100 | ent50 | ent20
ref_id (optional)
\n \n
Query Parameter — Customer specific identifier for this operation.
account_name (optional)
\n \n
Query Parameter — Account name.
account_description (optional)
\n \n
Query Parameter — The account description
user_name (optional)
\n \n
Query Parameter — The account owner's name. For example: &quot;John Doe&quot;.
log_level (optional)
\n \n
Query Parameter — Sets the log reporting level for the site.<br/>Possible values: full | security | none | default<br/>Default value is <b>none</b><br/>Available only for customers that purchased the Logs Integration SKU.
logs_account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account that purchased the logs integration SKU and which collects the logs.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.\nAvailable only for customers that purchased the Logs Integration SKU.
\n\n\n

Return type

\n
\n inline_response_200\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>1003 - Plan ID invalid<br/>1001 - Email invalid<br/>1010 - Account exists<br/>9403 - Unknown/unauthorized account_id\n inline_response_200\n

Example data

\n
Content-Type: success
\n 
{"account":{"email":"example@imperva.com","plan_id":"ent100","plan_name":"Enterprise 100","trial_end_date":"Jan 01, 2023 01:00:00 AM","account_id":1234,"parent_id":123,"ref_id":"222","user_name":"Example Account","account_name":"ExampleAccount","logins":[],"support_level":"Standard","support_all_tls_versions":false,"allow_ssl_validation_delegation":false,"wildcard_san_for_new_sites":"Default","naked_domain_san_for_new_www_sites":true,"enable_http2_for_new_sites":true,"enable_http2_to_origin_for_new_sites":false},"email":"example@email.info","plan_id":"ent100","plan_name":"Enterprise 100","account_type":"Reseller Example","account_id":1234,"parent_id":123,"user_name":"Example Account","account_name":"ExampleAccount","ref_id":"222","logins":[],"support_level":"Standard","support_all_tls_versions":false,"wildcard_san_for_new_sites":"Default","naked_domain_san_for_new_www_sites":true,"res":0,"res_message":"OK","debug_info":{"id-info":"999999"}}
\n

Example data

\n
Content-Type: error
\n 
{"res":1010,"res_message":"Account exists","debug_info":{"account_id":12345,"id-info":"999999"}}
\n
\n
\n \n 
post /api/prov/v1/subaccounts/add
\n
Add a new sub account (addSubAccount)
\n
Use this operation to add a new sub account to be managed by the account of the API client (the parent account).
\n\n\n\n\n\n

Query parameters

\n
\n
sub_account_name (required)
\n \n
Query Parameter — The name of the sub account.
parent_id (optional)
\n \n
Query Parameter — The newly created account's parent id. If not specified, the invoking account will be assigned as the parent account. format: int64
ref_id (optional)
\n \n
Query Parameter — Customer specific identifier for this operation.
log_level (optional)
\n \n
Query Parameter — Sets the log reporting level for the site.<br/>Possible values: full, security, none, default<br/>Available only for customers that purchased the Logs Integration SKU.
logs_account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account that purchased the logs integration SKU and which collects the logs.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.<br/>Available only for customers that purchased the Logs Integration SKU.
\n\n\n

Return type

\n
\n inline_response_200_1\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account_id<br/>9415 - Operation not allowed<br/>1015 - Maximum number of SubAccounts reached<br/>1003 - Plan ID invalid<br/>1010 - Account exists\n inline_response_200_1\n
\n
\n \n 
post /api/prov/v1/accounts/delete
\n
Delete managed account (deleteAccount)
\n
Available for Reseller accounts only\nUse this operation to delete an account.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>1 - Unexpected error<br/>2 - Invalid input<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/subaccounts/delete
\n
Delete sub account (deleteSubAccount)
\n
Use this operation to delete a sub account.
\n\n\n\n\n\n

Query parameters

\n
\n
sub_account_id (required)
\n \n
Query Parameter — Numeric identifier of the sub account to operate on. format: int64
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>1 - Unexpected error<br/>2002 - Invalid input2001 - Object is not empty<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/account
\n
Get account status (getAccountStatus)
\n
Use this operation to get account status
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
\n\n\n

Return type

\n
\n ApiResultAccountStatus\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ],\n  "account" : {\n    "support_all_tls_versions" : true,\n    "domains_for_ssl_validation_delegation" : [ "domains_for_ssl_validation_delegation", "domains_for_ssl_validation_delegation" ],\n    "naked_domain_san_for_new_www_sites" : true,\n    "enable_http2_for_new_sites" : true,\n    "user_name" : "Jhon",\n    "cname_value_for_ssl_validation_delegation" : "abc.impervadns.net",\n    "log_level" : "full",\n    "John Account" : "Jhon",\n    "trial_end_date" : "2000-01-23T04:56:07.000+00:00",\n    "support_level" : "Standard",\n    "plan_name" : "Enterprise 100",\n    "account_id" : 10,\n    "allow_ssl_validation_delegation" : true,\n    "parent_id" : 123,\n    "wildcard_san_for_new_sites" : "TRUE",\n    "enable_http2_to_origin_for_new_sites" : true,\n    "logins" : [ {\n      "login_id" : "demo_account@incapsula.com",\n      "email_verified" : true\n    }, {\n      "login_id" : "demo_account@incapsula.com",\n      "email_verified" : true\n    } ],\n    "email" : "example@imperva.com",\n    "plan_id" : "ent100"\n  }\n}
\n\n

Produces

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

Responses

\n

200

\n Success\n ApiResultAccountStatus\n
\n
\n \n 
post /api/prov/v1/accounts/data-privacy/show
\n
Get default data storage region (getDefaultRegion)
\n
Use this operation to get the default data region of the account. (Available for Reseller accounts only)
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account id<br/>9414 - Feature not permitted<br/>9415 - User is not allowed to change region<br/>1- Unexpected error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/accounts/gettoken
\n
Get account login token (getToken)
\n
Tokens are used instead of user/password based authentication to log in to the Imperva Cloud Security Console.\nUse this operation to generate a token for an account. The token is valid for 15 minutes.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
partner_id (optional)
\n \n
Query Parameter — Numeric identifier of the parent id to operate on
\n\n\n

Return type

\n
\n ApiResultGetSsoToken\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ],\n  "generated_token" : "344ebcaf34dff34"\n}
\n\n

Produces

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

Responses

\n

200

\n Success\n ApiResultGetSsoToken\n
\n
\n \n 
post /api/prov/v1/accounts/list
\n
List managed accounts (listAccounts)
\n
Available for Reseller accounts only.
Use this operation to get the list of accounts that are managed by account of the API client (the parent account).
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
page_size (optional)
\n \n
Query Parameter — The number of objects to return in the response.<br/>Default: 50<br/>Maximum: 100
page_num (optional)
\n \n
Query Parameter — The page to return starting from 0. Default: '0
\n\n\n

Return type

\n
\n ApiResultListUsers\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ],\n  "accounts" : [ {\n    "support_all_tls_versions" : true,\n    "domains_for_ssl_validation_delegation" : [ "domains_for_ssl_validation_delegation", "domains_for_ssl_validation_delegation" ],\n    "naked_domain_san_for_new_www_sites" : true,\n    "enable_http2_for_new_sites" : true,\n    "user_name" : "Jhon",\n    "cname_value_for_ssl_validation_delegation" : "abc.impervadns.net",\n    "log_level" : "full",\n    "John Account" : "Jhon",\n    "trial_end_date" : "2000-01-23T04:56:07.000+00:00",\n    "support_level" : "Standard",\n    "plan_name" : "Enterprise 100",\n    "account_id" : 10,\n    "allow_ssl_validation_delegation" : true,\n    "parent_id" : 123,\n    "wildcard_san_for_new_sites" : "TRUE",\n    "enable_http2_to_origin_for_new_sites" : true,\n    "logins" : [ {\n      "login_id" : "demo_account@incapsula.com",\n      "email_verified" : true\n    }, {\n      "login_id" : "demo_account@incapsula.com",\n      "email_verified" : true\n    } ],\n    "email" : "example@imperva.com",\n    "plan_id" : "ent100"\n  }, {\n    "support_all_tls_versions" : true,\n    "domains_for_ssl_validation_delegation" : [ "domains_for_ssl_validation_delegation", "domains_for_ssl_validation_delegation" ],\n    "naked_domain_san_for_new_www_sites" : true,\n    "enable_http2_for_new_sites" : true,\n    "user_name" : "Jhon",\n    "cname_value_for_ssl_validation_delegation" : "abc.impervadns.net",\n    "log_level" : "full",\n    "John Account" : "Jhon",\n    "trial_end_date" : "2000-01-23T04:56:07.000+00:00",\n    "support_level" : "Standard",\n    "plan_name" : "Enterprise 100",\n    "account_id" : 10,\n    "allow_ssl_validation_delegation" : true,\n    "parent_id" : 123,\n    "wildcard_san_for_new_sites" : "TRUE",\n    "enable_http2_to_origin_for_new_sites" : true,\n    "logins" : [ {\n      "login_id" : "demo_account@incapsula.com",\n      "email_verified" : true\n    }, {\n      "login_id" : "demo_account@incapsula.com",\n      "email_verified" : true\n    } ],\n    "email" : "example@imperva.com",\n    "plan_id" : "ent100"\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n Success\n ApiResultListUsers\n
\n
\n \n 
post /api/prov/v1/accounts/listSubAccounts
\n
List account's sub accounts (listSubAccounts)
\n
Use this operation to get a list of sub accounts that are managed by the account of the API client (the parent account).
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
page_size (optional)
\n \n
Query Parameter — The number of objects to return in the response.<br/>Default: 50<br/>Maximum: 100
page_num (optional)
\n \n
Query Parameter — The page to return starting from 0. Default: 0
\n\n\n

Return type

\n
\n array[SubAccountStatus]\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
[ {\n  "ref_id" : "432",\n  "logs_account_id" : 15,\n  "sub_account_name" : "My Sub Account",\n  "parent_id" : 10,\n  "log_level" : "full",\n  "support_level" : "Standard",\n  "sub_account_id" : 10,\n  "logins" : [ {\n    "login_id" : "demo_account@incapsula.com",\n    "email_verified" : true\n  }, {\n    "login_id" : "demo_account@incapsula.com",\n    "email_verified" : true\n  } ]\n}, {\n  "ref_id" : "432",\n  "logs_account_id" : 15,\n  "sub_account_name" : "My Sub Account",\n  "parent_id" : 10,\n  "log_level" : "full",\n  "support_level" : "Standard",\n  "sub_account_id" : 10,\n  "logins" : [ {\n    "login_id" : "demo_account@incapsula.com",\n    "email_verified" : true\n  }, {\n    "login_id" : "demo_account@incapsula.com",\n    "email_verified" : true\n  } ]\n} ]
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9415 - Operation not allowed<br/>1002 - Account doesn't exist\n \n
\n
\n \n 
post /api/prov/v1/accounts/configure
\n
Modify account configuration (modifyAccountConfiguration)
\n
Use this operation to change the configuration of the account of the API client or one of its managed accounts.
\n\n\n

Consumes

\n This API call consumes the following media types via the Content-Type request header:\n
    \n
  • application/json
    • \n
\n\n

Request body

\n
\n
body string (optional)
\n \n
Body Parameter —
\n
\n\n\n

Query parameters

\n
\n
param (required)
\n \n
Query Parameter — Name of configuration parameter to set.<br/>Possible values for param and value parameters:<br/><ul><li><b>name</b> the updated name.</li><li><b>email</b> the updated e-mail address</li><li><b>plan_id</b> a plan id</li><li><b>error_page_template</b> a Base64 encoded template for an error page.</li><li><b>support_all_tls_versions</b> Use this operation to allow sites in the account to support all TLS versions for connectivity between clients (visitors) and the Imperva service. When this option is set, you can then enable the option per site to support all TLS versions. Possible values: true, false. Note: To remain PCI-compliant, do not enable this option.</li><li><b>naked_domain_san_for_new_www_sites</b> Use this option to determine if the naked domain SAN will be added to the SSL certificate for new www sites. Default value: true.</li><li><b>wildcard_san_for_new_sites</b> Use this option to determine if the wildcard SAN or the full domain SAN is added to the Imperva SSL certificate for new sites. Possible values: true, false, default (determined by plan) Default value: default.</li><li><b>ref_id</b> Sets the Reference ID, a free-text field that enables you to add a unique identifier to correlate an object in our service, such as a protected website, with an object on the customer side.</li><li><b>enable_http2_for_new_sites</b> Use this option to enable HTTP/2 for newly created SSL sites.</li><li><b>enable_http2_to_origin_for_new_sites</b> Use this option to enable HTTP/2 to Origin for newly created SSL sites. This option can only be enabled once HTTP/2 is enabled for newly created sites.</li><li><b>consent_required</b> Blocks Imperva from performing sensitive operations on your behalf. You can then activate consent via the Cloud Security Console UI. Possible values: true, false..</li><li><b>inactivity_timeout</b> Account inactivity timeout in millis. Possible values: 900000,1800000,3600000,5400000,7200000.</li></ul>
value (required)
\n \n
Query Parameter — According to the configuration paramater used.
\n\n\n

Return type

\n
\n inline_response_200\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>6001 - Invalid configuration parameter name<br/>6002 - Invalid configuration parameter value<br/>6003 - Action required<br/>6004 - Invalid inactivity timeout value<br/>2 - Invalid input<br/>9415 - Operation not allowed<br/>1 - Unexpected error\n inline_response_200\n

Example data

\n
Content-Type: success
\n 
{"res":0,"res_message":"OK","debug_info":{"enable_http2_for_new_sites":"false","id-info":"999999"}}
\n

Example data

\n
Content-Type: error
\n 
{"res":6001,"res_message":"Invalid configuration parameter name","debug_info":{"param":"param_not_exist","id-info":"999999"}}
\n
\n
\n \n 
post /api/prov/v1/accounts/setlog
\n
Modify account log level (modifyAccountLogLevel)
\n
Available for Reseller accounts only
Use this operation to change the account log configuration.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
log_level (required)
\n \n
Query Parameter — Sets the log reporting level for the site.<br/> Possible values: full | security | none | default<br/>Available only for customers that purchased the Log Integration SKU.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>6001 - Invalid configuration parameter name<br/>1003 - Plan ID invalid<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/accounts/data-privacy/set-region-default
\n
Set default data storage region (setDefaultRegion)
\n
Use this operation to set the default data region of the account for newly created sites. (Available for Reseller accounts only)
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
data_storage_region (optional)
\n \n
Query Parameter — The data region to use.<br/>Possible values: US | EU | APAC | AU
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account id<br/>9414 - Feature not permitted<br/>1- Unexpected error<br/>2 - Invalid region.\n ApiResult\n
\n
\n \n 
post /api/prov/v1/accounts/setDefaultSiemStorage
\n
Set Imperva servers for log storage (setDefaultSiemStorage)
\n
Use this operation to have your logs saved on Incapsula servers. Once configured, the logs can be retrieved by API calls. Note: Before this operation can be used, logs must be activated using /api/prov/v1/waf-log-setup/activate
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account id<br/>9414 - Feature not permitted<br/>1- Unexpected error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/accounts/setAmazonSiemStorage
\n
Set S3 configuration for log storage (setStorageToS3)
\n
Use this operation to configure your Amazon cloud storage. Once configured, Imperva logs will be uploaded to the selected location. Note: Before this operation can be used, logs must be activated using /api/prov/v1/waf-log-setup/activate
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on
bucket_name (required)
\n \n
Query Parameter — S3 bucket name
access_key (required)
\n \n
Query Parameter — S3 access key
secret_key (required)
\n \n
Query Parameter — S3 secret key
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account id<br/>9414 - Feature not permitted<br/>1- Unexpected error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/accounts/setSftpSiemStorage
\n
Set SFTP server configuration for log storage (setStorageToSftp)
\n
Use this operation to configure your SFTP server storage. Once configured, Incapsula logs will be uploaded to the selected location. Note: Before this operation can be used, logs must be activated using /api/prov/v1/waf-log-setup/activate
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on
host (required)
\n \n
Query Parameter — The IP address of your SFTP server
user_name (required)
\n \n
Query Parameter — A user name that will be used to log in to the SFTP server
password (required)
\n \n
Query Parameter — A corresponding password for the user account used to log in to the SFTP server
destination_folder (required)
\n \n
Query Parameter — The path to the directory on the SFTP server
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account id<br/>9414 - Feature not permitted<br/>1- Unexpected error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/accounts/subscription
\n
Get account subscription details (subscription)
\n
Use this operation to get subscription details for an account.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters. format: int64
\n\n\n

Return type

\n
\n inline_response_200_2\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n Success\n inline_response_200_2\n
\n
\n \n 
post /api/prov/v1/accounts/testS3Connection
\n
Test connection with S3 bucket (testConnectionS3)
\n
Use this operation to check that a connection can be created with your Amazon S3 bucket. Note: Before this operation can be used, logs must be activated using /api/prov/v1/waf-log-setup/activate
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on
bucket_name (required)
\n \n
Query Parameter — S3 bucket name
access_key (required)
\n \n
Query Parameter — S3 access key
secret_key (required)
\n \n
Query Parameter — S3 secret key
save_on_success (optional)
\n \n
Query Parameter — Save this configuration if the test connection was successful. Default value:false
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account id<br/>9414 - Feature not permitted<br/>1- Unexpected error<br/>6002- Invalid configuration parameter value\n ApiResult\n
\n
\n \n 
post /api/prov/v1/accounts/testSftpConnection
\n
Test connection with SFTP server (testConnectionSftp)
\n
Use this operation to check that a connection can be created with your SFTP storage. Note: Before this operation can be used, logs must be activated using /api/prov/v1/waf-log-setup/activate
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on.
host (required)
\n \n
Query Parameter — The IP address of your SFTP server
user_name (required)
\n \n
Query Parameter — A user name that will be used to log in to the SFTP server
password (required)
\n \n
Query Parameter — A corresponding password for the user account used to log in to the SFTP server
destination_folder (required)
\n \n
Query Parameter — The path to the directory on the SFTP server
save_on_success (optional)
\n \n
Query Parameter — Save this configuration if the test connection was successful. Default value: false
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account id<br/>9414 - Feature not permitted<br/>1- Unexpected error<br/>6002- Invalid configuration parameter value\n ApiResult\n

DDoSForNetworksTestAlerts

\n
\n \n 
post /api/v1/infra-protect/test-alerts/bgp/down
\n
bgp down (postInfraProtectBgpDown)
\n
Use this operation to send a test notification informing you that the Infrastructure Protection bgp is down.
\n\n\n\n\n\n

Query parameters

\n
\n
bgp_id (optional)
\n \n
Query Parameter — The bgp to send a notification for. format: int64
\n\n\n

Return type

\n
\n inline_response_200_36\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_36\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/bgp/up
\n
Bgp up (postInfraProtectBgpUp)
\n
Use this operation to send a test notification informing you that the Infrastructure Protection bgp is up.
\n\n\n\n\n\n

Query parameters

\n
\n
bgp_id (optional)
\n \n
Query Parameter — The bgp to send a notification for. format: int64
\n\n\n

Return type

\n
\n inline_response_200_36\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_36\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/ddos/start
\n
DDoS start (postInfraProtectDdosStart)
\n
Use this operation to send a test notification informing you that an Infrastructure Protection DDoS attack has started.
You can optionally provide additional parameters to determine the magnitude of the attack.
\n\n\n\n\n\n

Query parameters

\n
\n
ip_prefix (optional)
\n \n
Query Parameter — The IP prefix to send a notification for. For example, 10.10.10.10
bps (optional)
\n \n
Query Parameter — Number of bits per second format: int32
pps (optional)
\n \n
Query Parameter — Number of packets per second format: int64
\n\n\n

Return type

\n
\n inline_response_200_37\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_37\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/ddos/stop
\n
DDoS stop (postInfraProtectDdosStop)
\n
Use this operation to send a test notification informing you that an Infrastructure Protection DDoS attack has ended.
You can optionally provide additional parameters to determine the magnitude of the attack.
\n\n\n\n\n\n

Query parameters

\n
\n
ip_prefix (optional)
\n \n
Query Parameter — The IP prefix to send a notification for. For example, 10.10.10.10
bps (optional)
\n \n
Query Parameter — Number of bits per second format: int32
pps (optional)
\n \n
Query Parameter — Number of packets per second format: int64
\n\n\n

Return type

\n
\n inline_response_200_37\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_37\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/monitoring/attack-start
\n
Monitoring attack start (postInfraProtectMonitoringAttackStartCriticalAlert)
\n
Use this operation to send a test notification informing you that the monitoring service has detected a DDoS attack.
You can optionally provide additional parameters to determine the magnitude of the attack.
\n\n\n\n\n\n

Query parameters

\n
\n
ip_prefix (optional)
\n \n
Query Parameter — The IP range to send a notification for. For example, 1.1.1.0/24
bps (optional)
\n \n
Query Parameter — Number of bits per second format: int32
pps (optional)
\n \n
Query Parameter — Number of packets per second format: int64
packet_type (optional)
\n \n
Query Parameter — Packet type. (UDP, TCP, DNS, DNS_RESPONSE, ICMP, SYN, FRAG, LARGE_SYN, NTP, NETFLOW, SSDP, GENERAL)
\n\n\n

Return type

\n
\n inline_response_200_37\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_37\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/monitoring/bad-data
\n
Monitoring bad data (postInfraProtectNetFlowBadData)
\n
Use this operation to send a test notification informing you that the monitoring service is receiving messages that do not conform to the accepted format.
You can optionally provide the exporter IP found in the Management Console’s Monitoring Settings page.
\n\n\n\n\n\n

Query parameters

\n
\n
exporter_ip (optional)
\n \n
Query Parameter — The exporter IP to send a notification for. For example, 10.10.10.10.<br/>The exporter IP can be found in the Cloud Security Console’s Monitoring Settings page.
\n\n\n

Return type

\n
\n inline_response_200_38\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_38\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/monitoring/start
\n
Monitoring start (postInfraProtectNetFlowStart)
\n
Use this operation to send a test notification informing you that flow monitoring has started.
You can optionally provide the exporter IP found in the Management Console’s Monitoring Settings page.
\n\n\n\n\n\n

Query parameters

\n
\n
exporter_ip (optional)
\n \n
Query Parameter — The exporter IP to send a notification for. For example, 10.10.10.10.<br/>The exporter IP can be found in the Cloud Security Console’s Monitoring Settings page.
\n\n\n

Return type

\n
\n inline_response_200_38\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_38\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/monitoring/stop
\n
Monitoring stop (postInfraProtectNetFlowStop)
\n
Use this operation to send a test notification informing you that NetFlow monitoring has stopped.
\n\n\n\n\n\n

Query parameters

\n
\n
exporter_ip (optional)
\n \n
Query Parameter — The exporter IP to send a notification for. For example, 10.10.10.10.<br/>The exporter IP can be found in the Cloud Security Console’s Monitoring Settings page.
\n\n\n

Return type

\n
\n inline_response_200_38\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_38\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/connection/down
\n
Connection down (postInfraProtectTunnelDown)
\n
Use this operation to send a test notification informing you that the Infrastructure Protection connection is down.
You can optionally provide the name of the connection as it appears in the Management Console’s Protection Settings page.
\n\n\n\n\n\n

Query parameters

\n
\n
connection_name (optional)
\n \n
Query Parameter — The connection to send a notification for.<br/>Enter the connection name as it appears in the Cloud Security Console’s Protection Settings page. For example, Test_GRE_Tunnel.
\n\n\n

Return type

\n
\n inline_response_200_36\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_36\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/connection/up
\n
Connection up (postInfraProtectTunnelUp)
\n
Use this operation to send a test notification informing you that the Infrastructure Protection connection is up.
You can optionally provide the name of the connection as it appears in the Management Console’s Protection Settings page.
\n\n\n\n\n\n

Query parameters

\n
\n
connection_name (optional)
\n \n
Query Parameter — The connection to send a notification for.<br/>Enter the connection name as it appears in the Cloud Security Console’s Protection Settings page. For example, Test_GRE_Tunnel.
\n\n\n

Return type

\n
\n inline_response_200_36\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_36\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/ip-protection-status/down
\n
IP protection status down (postProtectedIPStatusDown)
\n
Use this operation to send a test notification informing you that the IP Protection status is down.
\n\n\n\n\n\n

Query parameters

\n
\n
ip_protection (optional)
\n \n
Query Parameter — The IP to send a notification for. For example, 10.10.10.10
\n\n\n

Return type

\n
\n inline_response_200_39\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_39\n
\n
\n \n 
post /api/v1/infra-protect/test-alerts/ip-protection-status/up
\n
IP protection status up (postProtectedIPStatusUp)
\n
Use this operation to send a test notification informing you that the IP Protection status is up.
\n\n\n\n\n\n

Query parameters

\n
\n
ip_protection (optional)
\n \n
Query Parameter — The IP to send a notification for. For example, 10.10.10.10
\n\n\n

Return type

\n
\n inline_response_200_37\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9414 - Feature not permitted\n inline_response_200_37\n

DDoSProtectionForIndividualIPs

\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/add/cname
\n
Protected IP over TCP - add by origin IP (addSipByCname)
\n
Use this operation to onboard a CNAME record to the 'IP Protection over TCP' service.\nIf successful, the operation will return the generated Edge IP.
\n\n\n\n\n\n

Query parameters

\n
\n
cname (required)
\n \n
Query Parameter — CNAME record to onboard to service
enable_ha_protocol (optional)
\n \n
Query Parameter — Provide 'true' to enable the Proxy Protocol setting (disabled by default)
description (optional)
\n \n
Query Parameter — Optional description for the generated Edge IP
monitoring_type (optional)
\n \n
Query Parameter — Monitoring type for the Edge IP. Possible values: 'ICMP' (default), 'TCP' or 'NONE'
tcp_monitoring_port (optional)
\n \n
Query Parameter — Port to use for TCP monitoring of the Edge IP. Required only when TCP monitoring is used. format: int32
\n\n\n

Return type

\n
\n inline_response_200_40\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7002 - IP Protection quota exceeded<br/>7007 - This entity is already protected</br>7008 - CNAME cannot be used\n inline_response_200_40\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/add/dns-with-cname
\n
Protected IP over TCP - add by DNS and CNAME (addSipByDnsAndCname)
\n
Use this operation to onboard a CNAME record with an associated DNS name to the 'IP Protection over TCP' service.\nIf DNS check is enabled, the response will include the list of resolved CNAME records for the provided domain name, and the operation will only succeed if the provided CNAME will be included in that list.\nIf successful, the operation will return the generated Edge IP.
\n\n\n\n\n\n

Query parameters

\n
\n
dns_name (required)
\n \n
Query Parameter — Domain name to onboard to service
cname (required)
\n \n
Query Parameter — CNAME record to onboard to service
disable_dns_check (optional)
\n \n
Query Parameter — Provide 'true' to disable DNS resolution check (enabled by default)
enable_ha_protocol (optional)
\n \n
Query Parameter — Provide 'true' to enable the Proxy Protocol setting (disabled by default)
description (optional)
\n \n
Query Parameter — description for the generated Edge IP
monitoring_type (optional)
\n \n
Query Parameter — Monitoring type for the Edge IP. Possible values: 'ICMP' (default), 'TCP' or 'NONE
tcp_monitoring_port (optional)
\n \n
Query Parameter — Port to use for TCP monitoring of the Edge IP. Required only when TCP monitoring is used. format: int32
\n\n\n

Return type

\n
\n inline_response_200_41\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7002 - IP Protection quota exceeded<br/>7004 - Domain name cannot be used<br/>7005 - No DNS records found<br/>7007 - This entity is already protected<br/>7008 - CNAME cannot be used<br/>7009 - CNAME not among DNS resolved records\n inline_response_200_41\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/add/dns-with-ip
\n
Protected IP over TCP - add by DNS and origin IP (addSipByDnsAndIp)
\n
Use this operation to onboard a public origin IP with an associated DNS name to the 'IP Protection over TCP' service.\nIf DNS check is enabled, the response will include the list of resolved IPs for the provided domain name, and the operation will only succeed if the provided origin IP will be included in that list.\nIf successful, the operation will return the generated Edge IP.
\n\n\n\n\n\n

Query parameters

\n
\n
dns_name (required)
\n \n
Query Parameter — Domain name to onboard to service
origin_ip (required)
\n \n
Query Parameter — Public origin IP to onboard to service
disable_dns_check (optional)
\n \n
Query Parameter — Provide 'true' to disable DNS resolution check (enabled by default)
enable_ha_protocol (optional)
\n \n
Query Parameter — Provide 'true' to enable the Proxy Protocol setting (disabled by default)
description (optional)
\n \n
Query Parameter — description for the generated Edge IP
monitoring_type (optional)
\n \n
Query Parameter — Monitoring type for the Edge IP. Possible values: 'ICMP' (default), 'TCP' or 'NONE
tcp_monitoring_port (optional)
\n \n
Query Parameter — Port to use for TCP monitoring of the Edge IP. Required only when TCP monitoring is used. format: int32
\n\n\n

Return type

\n
\n inline_response_200_42\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7001 - IP not among DNS resolved records<br/>7002 - IP Protection quota exceeded<br/>7003 - IP cannot be used<br/>7004 - Domain name cannot be used<br/>7005 - No DNS records found<br/>7007 - This entity is already protected\n inline_response_200_42\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/add/ip
\n
Protected IP over TCP - add by CNAME (addSipByIp)
\n
Use this operation to onboard a public origin IP to the 'IP Protection over TCP' service.\nIf successful, the operation will return the generated Edge IP.
\n\n\n\n\n\n

Query parameters

\n
\n
origin_ip (required)
\n \n
Query Parameter — Public origin IP to onboard to service
enable_ha_protocol (optional)
\n \n
Query Parameter — Provide 'true' to enable the Proxy Protocol setting (disabled by default)
description (optional)
\n \n
Query Parameter — description for the generated Edge IP
monitoring_type (optional)
\n \n
Query Parameter — Monitoring type for the Edge IP. Possible values: 'ICMP' (default), 'TCP' or 'NONE'
tcp_monitoring_port (optional)
\n \n
Query Parameter — Port to use for TCP monitoring of the Edge IP. Required only when TCP monitoring is used. format: int32
\n\n\n

Return type

\n
\n inline_response_200_43\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7002 - IP Protection quota exceeded<br/>7003 - IP cannot be used<br/>7007 - This entity is already protected\n inline_response_200_43\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/edit/cname
\n
Protected IP over TCP - edit by CNAME (editSipByCname)
\n
Use this operation to assign a new CNAME record to the provided Edge IP under the 'IP Protection over TCP' service.\nThis operation is also able to change the type of the entity protected by the provided Edge IP (Any existing combination of Origin IP/CNAME and DNS will be overwritten).\nIf successful, the operation will return the Edge IP.\nWARNING: Any entity already protected by this Edge IP prior to the change will no longer be protected once modification is successful, unless duplicate protection is used.
\n\n\n\n\n\n

Query parameters

\n
\n
edge_ip (required)
\n \n
Query Parameter — Imperva generated Edge IP
cname (required)
\n \n
Query Parameter — CNAME to onboard to service
\n\n\n

Return type

\n
\n inline_response_200_40\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7003 - IP cannot be used<br/>7006 - Edge IP not found<br/>7007 - This entity is already protected<br/>7008 - CNAME cannot be used\n inline_response_200_40\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/edit/dns-with-cname
\n
Protected IP over TCP - edit by DNS and origin IP (editSipByDnsAndCname)
\n
Use this operation to assign a new CNAME record with an associated DNS name to the provided Edge IP under the 'IP Protection over TCP' service.
This operation is also able to change the type of the entity protected by the provided Edge IP (Any existing combination of Origin IP/CNAME and DNS name will be overwritten).
If DNS check is enabled, the response will include the list of resolved CNAME records for the provided domain name, and the operation will only succeed if the provided CNAME is included in that list.
If successful, the operation will return the Edge IP.
WARNING: Any entity already protected by this Edge IP prior to the change will no longer be protected once modification is successful, unless duplicate protection is used.
\n\n\n\n\n\n

Query parameters

\n
\n
edge_ip (required)
\n \n
Query Parameter — Imperva generated Edge IP
dns_name (required)
\n \n
Query Parameter — Domain name to onboard to service
cname (required)
\n \n
Query Parameter — CNAME to onboard to service
disable_dns_check (optional)
\n \n
Query Parameter — Provide 'true' to disable DNS resolution check (enabled by default)
\n\n\n

Return type

\n
\n inline_response_200_41\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7003 - IP cannot be used<br/>7004 - Domain name cannot be used<br/>7005 - No DNS records found<br/>7006 - Edge IP not found<br/>7007 - This entity is already protected<br/>7008 - CNAME cannot be used<br/>7009 - CNAME not among DNS resolved records\n inline_response_200_41\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/edit/dns-with-ip
\n
Protected IP over TCP - edit by DNS and origin IP (editSipByDnsAndIp)
\n
Use this operation to assign a new origin IP with an associated DNS name to the provided Edge IP under the 'IP Protection over TCP' service.\nThis operation is also able to change the type of the entity protected by the provided Edge IP (Any existing combination of Origin IP/CNAME and DNS name will be overwritten).\nIf DNS check is enabled, the response will include the list of resolved IPs for the provided domain name, and the operation will only succeed if the provided origin IP is included in that list.\nIf successful, the operation will return the Edge IP.\nWARNING: Any entity already protected by this Edge IP prior to the change will no longer be protected once modification is successful, unless duplicate protection is used.
\n\n\n\n\n\n

Query parameters

\n
\n
edge_ip (required)
\n \n
Query Parameter — Imperva generated Edge IP
dns_name (required)
\n \n
Query Parameter — Domain name to onboard to service
origin_ip (required)
\n \n
Query Parameter — Public origin IP to onboard to service
disable_dns_check (optional)
\n \n
Query Parameter — Provide 'true' to disable DNS resolution check (enabled by default)
\n\n\n

Return type

\n
\n inline_response_200_42\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7001 - IP not among DNS resolved records<br/>7003 - IP cannot be used<br/>7004 - Domain name cannot be used<br/>7005 - No DNS records found<br/>7006 - Edge IP not found<br/>7007 - This entity is already protected\n inline_response_200_42\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/edit/ip
\n
Protected IP over TCP - edit by origin IP (editSipByIp)
\n
Use this operation to assign a new origin IP to the provided Edge IP under the 'IP Protection over TCP' service.\nThis operation is also able to change the type of the entity protected by the provided Edge IP (Any existing combination of Origin IP/CNAME and DNS name will be overwritten).\nIf successful, the operation will return the Edge IP.\nWARNING: Any entity already protected by this Edge IP prior to the change will no longer be protected once modification is successful, unless duplicate protection is used.
\n\n\n\n\n\n

Query parameters

\n
\n
edge_ip (required)
\n \n
Query Parameter — Imperva generated Edge IP
origin_ip (required)
\n \n
Query Parameter — Public origin IP to onboard to service
\n\n\n

Return type

\n
\n inline_response_200_43\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7003 - IP cannot be used<br/>7006 - Edge IP not found<br/>7007 - This entity is already protected\n inline_response_200_43\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/edit/ha-protocol
\n
Protected IP over TCP - edit HA protocol setting (editSipHaProtocol)
\n
Use this operation on the provided Edge IP to toggle its HA Protocol setting on or off.\nBy default, this setting is disabled during onboarding unless explicitly set to 'true'.\nWARNING: Do not modify this setting unless you are familiar with the proxy protocol and understand the implications of enabling or disabling it for your account.
\n\n\n\n\n\n

Query parameters

\n
\n
edge_ip (required)
\n \n
Query Parameter — Imperva generated Edge IP
enable_ha_protocol (required)
\n \n
Query Parameter — Provide 'true' to enable the Proxy Protocol setting, 'false' to disable
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7003 - IP cannot be used</br>7006 - Edge IP not found\n ApiResult\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/edit/monitoring-settings
\n
Protected IP over TCP - edit monitoring settings (editSipMonitoringSettings)
\n
Use this operation on the specified Edge IP to modify its monitoring settings.
\n\n\n\n\n\n

Query parameters

\n
\n
edge_ip (required)
\n \n
Query Parameter — Imperva generated Edge IP
monitoring_type (required)
\n \n
Query Parameter — Monitoring type for the Edge IP. Possible values: 'ICMP' (default), 'TCP' or 'NONE'
tcp_monitoring_port (optional)
\n \n
Query Parameter — Port to use for TCP monitoring of the Edge IP. Required only when TCP monitoring is used. format: int32
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7003 - IP cannot be used<br/>7006 - Edge IP not found\n ApiResult\n
\n
\n \n 
post /api/prov/v1/ddos-protection/edge-ip/remove
\n
Protected IP over TCP - remove (removeSip)
\n
Use this operation on the provided Edge IP to remove it from the 'IP Protection over TCP' service.
WARNING: Any entity already protected by this Edge IP will no longer be protected once the operation is successful, unless duplicate protection was enabled and used.
\n\n\n\n\n\n

Query parameters

\n
\n
edge_ip (required)
\n \n
Query Parameter — Imperva generated Edge IP
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>7003 - IP cannot be used<br/>7006 - Edge IP not found\n ApiResult\n

DDoSProtectionPolicyVisibility

\n
\n \n 
get /api/prov/v3/ddos-protection/monitor-policy
\n
Get monitoring policy (getMonitorPolicy)
\n
Use this operation to view the monitoring policy of a Protected Range
\n\n\n\n\n\n

Query parameters

\n
\n
ipRange (required)
\n \n
Query Parameter — IP Range
\n\n\n

Return type

\n
\n inline_response_200_44\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>7101 - Policy not found<br/>\n inline_response_200_44\n
\n
\n \n 
get /api/prov/v3/ddos-protection/monitor-policy/revisions
\n
Get monitoring policy revisions (getMonitorPolicyRevisions)
\n
Use this operation to view the last 2 revisions of threshold changes in the monitoring policy for a Protected Range
\n\n\n\n\n\n

Query parameters

\n
\n
ipRange (required)
\n \n
Query Parameter — IP Range
\n\n\n

Return type

\n
\n array[MonitoringPolicyRevisionResponse]\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
[ {\n  "policyRevisions" : [ {\n    "data" : {\n      "TCP" : [ {\n        "amount" : "100.0K PPS",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "70.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "200.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "UDP" : [ {\n        "amount" : "80.0K PPS",\n        "time" : "Over 45 sec"\n      }, {\n        "amount" : "200.0 Mbps",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "90.0 Mbps",\n        "time" : "Over 60 sec"\n      } ],\n      "OTHER" : [ {\n        "amount" : "30.0K PPS",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "10.0K PPS",\n        "time" : "Over 45 sec"\n      }, {\n        "amount" : "150.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "FRAG" : [ {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "DNS" : [ {\n        "amount" : "25.0K PPS",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      } ],\n      "SYN" : [ {\n        "amount" : "20.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "17.0K PPS",\n        "time" : "Over 75 sec"\n      } ],\n      "LARGE_SYN" : [ {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "SSDP" : [ {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "NTP" : [ {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 45 sec"\n      } ],\n      "ICMP" : [ {\n        "amount" : "20.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 30 sec"\n      } ]\n    },\n    "lastUpdate" : "2023-05-02T06:18:51Z"\n  } ]\n}, {\n  "policyRevisions" : [ {\n    "data" : {\n      "TCP" : [ {\n        "amount" : "100.0K PPS",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "70.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "200.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "UDP" : [ {\n        "amount" : "80.0K PPS",\n        "time" : "Over 45 sec"\n      }, {\n        "amount" : "200.0 Mbps",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "90.0 Mbps",\n        "time" : "Over 60 sec"\n      } ],\n      "OTHER" : [ {\n        "amount" : "30.0K PPS",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "10.0K PPS",\n        "time" : "Over 45 sec"\n      }, {\n        "amount" : "150.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "FRAG" : [ {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "DNS" : [ {\n        "amount" : "25.0K PPS",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      } ],\n      "SYN" : [ {\n        "amount" : "20.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "17.0K PPS",\n        "time" : "Over 75 sec"\n      } ],\n      "LARGE_SYN" : [ {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "SSDP" : [ {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 30 sec"\n      } ],\n      "NTP" : [ {\n        "amount" : "10.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 45 sec"\n      } ],\n      "ICMP" : [ {\n        "amount" : "20.0K PPS",\n        "time" : "Over 30 sec"\n      }, {\n        "amount" : "40.0 Mbps",\n        "time" : "Over 15 sec"\n      }, {\n        "amount" : "25.0 Mbps",\n        "time" : "Over 30 sec"\n      } ]\n    },\n    "lastUpdate" : "2023-05-02T06:18:51Z"\n  } ]\n} ]
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>7101 - Policy not found<br/>\n \n
\n
\n \n 
get /api/prov/v3/ddos-protection/security-policy
\n
Get security policy (getSecurityPolicy)
\n
Use this operation to view the security policy of a Protected IP or Protected Range. The thresholds determine at what point the range/IP is considered to be under DDoS attack. Mitigation is then started and the traffic is blocked.
\n\n\n\n\n\n

Query parameters

\n
\n
assetId (required)
\n \n
Query Parameter — Protected Range or Protected IP
isProtectedIp (required)
\n \n
Query Parameter — Indicates if the asset is a Protected IP or a Protected Range. Default is false, indicating that the asset is a Protected Range.
\n\n\n

Return type

\n
\n inline_response_200_45\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>7101 - Policy not found<br/>\n inline_response_200_45\n
\n
\n \n 
get /api/prov/v3/ddos-protection/security-policy/revisions
\n
Get security policy revisions (getSecurityPolicyRevisions)
\n
Use this operation to view the last 2 revisions of threshold changes in the security policy for a Protected IP or Protected Range. The thresholds determine at what point the range/IP is considered to be under DDoS attack. Mitigation is then started and the traffic is blocked.
\n\n\n\n\n\n

Query parameters

\n
\n
assetId (required)
\n \n
Query Parameter — Protected Range or Protected IP
isProtectedIp (required)
\n \n
Query Parameter — Indicates if the asset is a Protected IP or a Protected Range. Default is false, indicating that the asset is a Protected Range.
\n\n\n

Return type

\n
\n array[SecurityPolicyRevisionResponse]\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
[ {\n  "policyRevisions" : [ {\n    "singleIpThresholds" : {\n      "ppsThresholds" : {\n        "UDP" : "10.0K PPS",\n        "TCP" : "50.0K PPS",\n        "TOTAL" : "50.0K PPS",\n        "DNS_RESPONSE" : "0.3K PPS",\n        "DNS" : "0.3K PPS",\n        "SYN" : "0.5K PPS",\n        "SSDP" : "0.3K PPS",\n        "NTP" : "0.3K PPS",\n        "OTHER" : "3.0K PPS",\n        "FRAG" : "0.3K PPS",\n        "CUSTOM" : "0.3K PPS",\n        "LARGE_SYN" : "0.3K PPS",\n        "ICMP" : "0.3K PPS"\n      },\n      "bandwidthThresholds" : {\n        "UDP" : "10.0 Mbps",\n        "TCP" : "50.0 Mbps",\n        "TOTAL" : "50.0 Mbps",\n        "DNS_RESPONSE" : "0.2 Mbps",\n        "DNS" : "0.1 Mbps",\n        "SYN" : "0.4 Mbps",\n        "SSDP" : "0.1 Mbps",\n        "NTP" : "0.1 Mbps",\n        "OTHER" : "8.0 Mbps",\n        "FRAG" : "0.1 Mbps",\n        "CUSTOM" : "0.1 Mbps",\n        "LARGE_SYN" : "0.1 Mbps",\n        "ICMP" : "0.1 Mbps"\n      }\n    },\n    "ipRangeThresholds" : {\n      "ppsThresholds" : {\n        "UDP" : "10.0K PPS",\n        "TCP" : "50.0K PPS",\n        "TOTAL" : "50.0K PPS",\n        "DNS_RESPONSE" : "0.3K PPS",\n        "DNS" : "0.3K PPS",\n        "SYN" : "0.5K PPS",\n        "SSDP" : "0.3K PPS",\n        "NTP" : "0.3K PPS",\n        "OTHER" : "3.0K PPS",\n        "FRAG" : "0.3K PPS",\n        "CUSTOM" : "0.3K PPS",\n        "LARGE_SYN" : "0.3K PPS",\n        "ICMP" : "0.3K PPS"\n      },\n      "bandwidthThresholds" : {\n        "UDP" : "10.0 Mbps",\n        "TCP" : "50.0 Mbps",\n        "TOTAL" : "50.0 Mbps",\n        "DNS_RESPONSE" : "0.2 Mbps",\n        "DNS" : "0.1 Mbps",\n        "SYN" : "0.4 Mbps",\n        "SSDP" : "0.1 Mbps",\n        "NTP" : "0.1 Mbps",\n        "OTHER" : "8.0 Mbps",\n        "FRAG" : "0.1 Mbps",\n        "CUSTOM" : "0.1 Mbps",\n        "LARGE_SYN" : "0.1 Mbps",\n        "ICMP" : "0.1 Mbps"\n      }\n    },\n    "lastUpdate" : "2023-10-09T07:06:36Z"\n  }, {\n    "singleIpThresholds" : {\n      "ppsThresholds" : {\n        "UDP" : "10.0K PPS",\n        "TCP" : "50.0K PPS",\n        "TOTAL" : "50.0K PPS",\n        "DNS_RESPONSE" : "0.3K PPS",\n        "DNS" : "0.3K PPS",\n        "SYN" : "0.5K PPS",\n        "SSDP" : "0.3K PPS",\n        "NTP" : "0.3K PPS",\n        "OTHER" : "3.0K PPS",\n        "FRAG" : "0.3K PPS",\n        "CUSTOM" : "0.3K PPS",\n        "LARGE_SYN" : "0.3K PPS",\n        "ICMP" : "0.3K PPS"\n      },\n      "bandwidthThresholds" : {\n        "UDP" : "10.0 Mbps",\n        "TCP" : "50.0 Mbps",\n        "TOTAL" : "50.0 Mbps",\n        "DNS_RESPONSE" : "0.2 Mbps",\n        "DNS" : "0.1 Mbps",\n        "SYN" : "0.4 Mbps",\n        "SSDP" : "0.1 Mbps",\n        "NTP" : "0.1 Mbps",\n        "OTHER" : "8.0 Mbps",\n        "FRAG" : "0.1 Mbps",\n        "CUSTOM" : "0.1 Mbps",\n        "LARGE_SYN" : "0.1 Mbps",\n        "ICMP" : "0.1 Mbps"\n      }\n    },\n    "ipRangeThresholds" : {\n      "ppsThresholds" : {\n        "UDP" : "10.0K PPS",\n        "TCP" : "50.0K PPS",\n        "TOTAL" : "50.0K PPS",\n        "DNS_RESPONSE" : "0.3K PPS",\n        "DNS" : "0.3K PPS",\n        "SYN" : "0.5K PPS",\n        "SSDP" : "0.3K PPS",\n        "NTP" : "0.3K PPS",\n        "OTHER" : "3.0K PPS",\n        "FRAG" : "0.3K PPS",\n        "CUSTOM" : "0.3K PPS",\n        "LARGE_SYN" : "0.3K PPS",\n        "ICMP" : "0.3K PPS"\n      },\n      "bandwidthThresholds" : {\n        "UDP" : "10.0 Mbps",\n        "TCP" : "50.0 Mbps",\n        "TOTAL" : "50.0 Mbps",\n        "DNS_RESPONSE" : "0.2 Mbps",\n        "DNS" : "0.1 Mbps",\n        "SYN" : "0.4 Mbps",\n        "SSDP" : "0.1 Mbps",\n        "NTP" : "0.1 Mbps",\n        "OTHER" : "8.0 Mbps",\n        "FRAG" : "0.1 Mbps",\n        "CUSTOM" : "0.1 Mbps",\n        "LARGE_SYN" : "0.1 Mbps",\n        "ICMP" : "0.1 Mbps"\n      }\n    },\n    "lastUpdate" : "2022-09-01T08:30:14Z"\n  } ]\n}, {\n  "policyRevisions" : [ {\n    "singleIpThresholds" : {\n      "ppsThresholds" : {\n        "UDP" : "10.0K PPS",\n        "TCP" : "50.0K PPS",\n        "TOTAL" : "50.0K PPS",\n        "DNS_RESPONSE" : "0.3K PPS",\n        "DNS" : "0.3K PPS",\n        "SYN" : "0.5K PPS",\n        "SSDP" : "0.3K PPS",\n        "NTP" : "0.3K PPS",\n        "OTHER" : "3.0K PPS",\n        "FRAG" : "0.3K PPS",\n        "CUSTOM" : "0.3K PPS",\n        "LARGE_SYN" : "0.3K PPS",\n        "ICMP" : "0.3K PPS"\n      },\n      "bandwidthThresholds" : {\n        "UDP" : "10.0 Mbps",\n        "TCP" : "50.0 Mbps",\n        "TOTAL" : "50.0 Mbps",\n        "DNS_RESPONSE" : "0.2 Mbps",\n        "DNS" : "0.1 Mbps",\n        "SYN" : "0.4 Mbps",\n        "SSDP" : "0.1 Mbps",\n        "NTP" : "0.1 Mbps",\n        "OTHER" : "8.0 Mbps",\n        "FRAG" : "0.1 Mbps",\n        "CUSTOM" : "0.1 Mbps",\n        "LARGE_SYN" : "0.1 Mbps",\n        "ICMP" : "0.1 Mbps"\n      }\n    },\n    "ipRangeThresholds" : {\n      "ppsThresholds" : {\n        "UDP" : "10.0K PPS",\n        "TCP" : "50.0K PPS",\n        "TOTAL" : "50.0K PPS",\n        "DNS_RESPONSE" : "0.3K PPS",\n        "DNS" : "0.3K PPS",\n        "SYN" : "0.5K PPS",\n        "SSDP" : "0.3K PPS",\n        "NTP" : "0.3K PPS",\n        "OTHER" : "3.0K PPS",\n        "FRAG" : "0.3K PPS",\n        "CUSTOM" : "0.3K PPS",\n        "LARGE_SYN" : "0.3K PPS",\n        "ICMP" : "0.3K PPS"\n      },\n      "bandwidthThresholds" : {\n        "UDP" : "10.0 Mbps",\n        "TCP" : "50.0 Mbps",\n        "TOTAL" : "50.0 Mbps",\n        "DNS_RESPONSE" : "0.2 Mbps",\n        "DNS" : "0.1 Mbps",\n        "SYN" : "0.4 Mbps",\n        "SSDP" : "0.1 Mbps",\n        "NTP" : "0.1 Mbps",\n        "OTHER" : "8.0 Mbps",\n        "FRAG" : "0.1 Mbps",\n        "CUSTOM" : "0.1 Mbps",\n        "LARGE_SYN" : "0.1 Mbps",\n        "ICMP" : "0.1 Mbps"\n      }\n    },\n    "lastUpdate" : "2023-10-09T07:06:36Z"\n  }, {\n    "singleIpThresholds" : {\n      "ppsThresholds" : {\n        "UDP" : "10.0K PPS",\n        "TCP" : "50.0K PPS",\n        "TOTAL" : "50.0K PPS",\n        "DNS_RESPONSE" : "0.3K PPS",\n        "DNS" : "0.3K PPS",\n        "SYN" : "0.5K PPS",\n        "SSDP" : "0.3K PPS",\n        "NTP" : "0.3K PPS",\n        "OTHER" : "3.0K PPS",\n        "FRAG" : "0.3K PPS",\n        "CUSTOM" : "0.3K PPS",\n        "LARGE_SYN" : "0.3K PPS",\n        "ICMP" : "0.3K PPS"\n      },\n      "bandwidthThresholds" : {\n        "UDP" : "10.0 Mbps",\n        "TCP" : "50.0 Mbps",\n        "TOTAL" : "50.0 Mbps",\n        "DNS_RESPONSE" : "0.2 Mbps",\n        "DNS" : "0.1 Mbps",\n        "SYN" : "0.4 Mbps",\n        "SSDP" : "0.1 Mbps",\n        "NTP" : "0.1 Mbps",\n        "OTHER" : "8.0 Mbps",\n        "FRAG" : "0.1 Mbps",\n        "CUSTOM" : "0.1 Mbps",\n        "LARGE_SYN" : "0.1 Mbps",\n        "ICMP" : "0.1 Mbps"\n      }\n    },\n    "ipRangeThresholds" : {\n      "ppsThresholds" : {\n        "UDP" : "10.0K PPS",\n        "TCP" : "50.0K PPS",\n        "TOTAL" : "50.0K PPS",\n        "DNS_RESPONSE" : "0.3K PPS",\n        "DNS" : "0.3K PPS",\n        "SYN" : "0.5K PPS",\n        "SSDP" : "0.3K PPS",\n        "NTP" : "0.3K PPS",\n        "OTHER" : "3.0K PPS",\n        "FRAG" : "0.3K PPS",\n        "CUSTOM" : "0.3K PPS",\n        "LARGE_SYN" : "0.3K PPS",\n        "ICMP" : "0.3K PPS"\n      },\n      "bandwidthThresholds" : {\n        "UDP" : "10.0 Mbps",\n        "TCP" : "50.0 Mbps",\n        "TOTAL" : "50.0 Mbps",\n        "DNS_RESPONSE" : "0.2 Mbps",\n        "DNS" : "0.1 Mbps",\n        "SYN" : "0.4 Mbps",\n        "SSDP" : "0.1 Mbps",\n        "NTP" : "0.1 Mbps",\n        "OTHER" : "8.0 Mbps",\n        "FRAG" : "0.1 Mbps",\n        "CUSTOM" : "0.1 Mbps",\n        "LARGE_SYN" : "0.1 Mbps",\n        "ICMP" : "0.1 Mbps"\n      }\n    },\n    "lastUpdate" : "2022-09-01T08:30:14Z"\n  } ]\n} ]
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>7101 - Policy not found<br/>\n \n

Integrations

\n
\n \n 
post /api/integration/v1/clapps
\n
Get client applications info (getClappsInfo)
\n
Use this operation to retrieve a list of all the client applications.
\n\n\n\n\n\n\n\n

Return type

\n
\n ApiResultGetClappsInfo\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "clientApps" : {\n    "1" : "Firefox"\n  },\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ],\n  "clientAppTypes" : {\n    "1" : "Browser"\n  }\n}
\n\n

Produces

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

Responses

\n

200

\n Success\n ApiResultGetClappsInfo\n
\n
\n \n 
post /api/integration/v1/geo
\n
Get geographical info (getGeoInfo)
\n
Use this operation to retrieve a list of all the countries and continents codes.
\n\n\n\n\n\n\n\n

Return type

\n
\n GeoInfo\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ],\n  "continentsCodes" : {\n    "AF" : "Africa"\n  },\n  "countriesCodes" : {\n    "BD" : "Bangladesh",\n    "BE" : "Belgium"\n  }\n}
\n\n

Produces

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

Responses

\n

200

\n Success\n GeoInfo\n
\n
\n \n 
get /api/integration/v1/ips
\n
Get Imperva IP ranges (getIPRanges)
\n
Use this operation to get the updated list of Imperva IP ranges. This list may be used to define firewall rules that restrict access to customers sites from non-Imperva IPs.
\n\n\n\n\n\n

Query parameters

\n
\n
resp_format (optional)
\n \n
Query Parameter — Response format.<br/>Possible values: json | apache | nginx | iptables | text<br/>Default: json
\n\n\n

Return type

\n
\n inline_response_200_13\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>14001 - Format invalid\n inline_response_200_13\n
\n
\n \n 
post /api/integration/v1/ips
\n
Get Imperva IP ranges (getIPRangesWithPost)
\n
Use this operation to get the updated list of Imperva IP ranges. This list may be used to define firewall rules that restrict access to customers sites from non-Imperva IPs.
\n\n\n\n\n\n

Query parameters

\n
\n
resp_format (optional)
\n \n
Query Parameter — Response format.<br/>Possible values: json | apache | nginx | iptables | text<br/>Default: json
\n\n\n

Return type

\n
\n inline_response_200_13\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>14001 - Format invalid\n inline_response_200_13\n
\n
\n \n 
post /api/integration/v1/texts
\n
Get texts (getTexts)
\n
Use this operation to retrieve a list of all text messages that may be part of API responses. For each message a key and a value are provided. The key is the unique identifier of the message and the value is the message text itself, in the API's default locale (English).
\n\n\n\n\n\n\n\n

Return type

\n
\n ApiResultGetTexts\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ],\n  "texts" : {\n    "api.stats.visits_timeseries.human" : "Human visits",\n    "api.stats.visits_timeseries.bot" : "Bot visits",\n    "api.threats.followup.view" : "View Incidents"\n  }\n}
\n\n

Produces

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

Responses

\n

200

\n Success\n ApiResultGetTexts\n

LoginProtect

\n
\n \n 
post /api/prov/v1/sites/lp/add-user
\n
Add login protect user (addLpUser)
\n
Use this operation to add a Login Protect user for a site.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on.
email (required)
\n \n
Query Parameter — Email address.
name (optional)
\n \n
Query Parameter — Example: John Smith
phone (optional)
\n \n
Query Parameter — Phone number. For example: &quot;1-8662507659&quot;
is_phone_verified (optional)
\n \n
Query Parameter — Whether or not to skip phone verification.
is_email_verified (optional)
\n \n
Query Parameter — Whether or not to skip email address verification.
should_send_activation_email (optional)
\n \n
Query Parameter — Whether or not to send activation email to user.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:</br>9403 - Unknown/unauthorized account_id<br/>1001 - E-mail invalid</br>18005 - Login Protect User Exists</br>18006 - Operation Not Allowed</br>18009 - Not Supported Action<br/>18004 - Failed to Send E-Mail\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/lp/configure-app
\n
Configure login protect on admin areas (configureProtectedAppByLp)
\n
Use this operation to configure Login Protect on wordpress | joomla | phpbb admin areas.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
protected_app (optional)
\n \n
Query Parameter — Protect admin areas of joomla | wordpress | phpBB.
\n\n\n

Return type

\n
\n inline_response_200_14\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>18001 - Format invalid<br/>18002 - Application invalid<br/>18011 - Invalid SMS Text<br/>9403 - Unknown/unauthorized account_id<br/>1001 - E-mail invalid<br/>18003 - Invalid phone number\n inline_response_200_14\n
\n
\n \n 
post /api/prov/v1/sites/lp/edit-user
\n
Edit login protect user (editLpUser)
\n
Edit Login Protect user's settings.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on.
email (required)
\n \n
Query Parameter — Email address.
name (optional)
\n \n
Query Parameter — Example: John Smith
phone (optional)
\n \n
Query Parameter — Phone number. For example: &quot;1-8662507659&quot;
is_phone_verified (optional)
\n \n
Query Parameter — Whether or not to skip phone verification.
is_email_verified (optional)
\n \n
Query Parameter — Whether or not to skip email address verification.
should_send_activation_email (optional)
\n \n
Query Parameter — Whether or not to send activation email to user.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account_id<br/>1001 - E-mail invalid<br/>18005 - Login Protect User Exists<br/>18006 - Operation Not Allowed<br/>18009 - Not Supported Action</br>18004 - Failed to Send E-Mail\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/lp/users
\n
Get login protect users (getLpUsers)
\n
Use this operation to get the account's login protect user list.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on.
\n\n\n

Return type

\n
\n inline_response_200_15\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>18003 - Invalid phone number</br>18004 - Failed to Send E-Mail<br/>9403 - Unknown/unauthorized account_id<br/>1001 - E-mail invalid</br>18005 - Login Protect User Exists<br/>18006 - Operation Not Allowed\n inline_response_200_15\n
\n
\n \n 
post /api/prov/v1/sites/lp/configure
\n
Modify Site Login Protect Configuration (modifyLpSiteConfiguration)
\n
Use this operation to change Login Protect settings for a site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
enabled (optional)
\n \n
Query Parameter — Pass true to enable login protect on site, and false to disable it.<br/>Default: true
specific_users_list (optional)
\n \n
Query Parameter — Comma separated email list to set login protect users for the site. If the list is empty all users will be allowed to access the site using Login Protect.
send_lp_notifications (optional)
\n \n
Query Parameter — Pass true to send notification on successful login using login protect.<br/>Default: false
allow_all_users (optional)
\n \n
Query Parameter — Pass true to allow all login protect users to access the site. If you want to allow only a specific list of users to access the site using Login Protect set this to false, and add the list to specific_user_list.<br/>Default: true
authentication_methods (optional)
\n \n
Query Parameter — Comma separated list of allowed authentication methods: sms | email | ga
urls (optional)
\n \n
Query Parameter — A comma separated list of resource paths. For example, /home and /admin/index.html are resource paths, while <a href="http://www.example.com/home">http://www.example.com/home</a> is not. Each URL should be encoded separately using percent encoding as specified by RFC 3986 (<a href="http://tools.ietf.org/html/rfc3986#section-2.1">http://tools.ietf.org/html/rfc3986#section-2.1</a>). An empty URL list will remove all URLs.
url_patterns (optional)
\n \n
Query Parameter — A comma separated list of url patterns. Possible values: contains | equals | prefix | suffix | not_equals | not_contain | not_prefix | not_suffix. The patterns should be in accordance with the matching urls sent by the urls parameter.
\n\n\n

Return type

\n
\n inline_response_200_14\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id</br>18001 - Format invalid<br/>18002 - Application invalid<br/>18011 - Invalid SMS Text<br/>9403 - Unknown/unauthorized account_id<br/>1001 - E-mail invalid<br/>18003 - Invalid phone number\n inline_response_200_14\n
\n
\n \n 
post /api/prov/v1/sites/lp/remove
\n
Remove login protect user (removeLpUser)
\n
Use this operation to remove a login protect user from an account's user list.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on.
email (required)
\n \n
Query Parameter — Email address.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>18003 - Invalid phone number<br/>18004 - Failed to Send E-Mail<br/>9403 - Unknown/unauthorized account_id<br/>1001 - E-mail invalid<br/>18005 - Login Protect User Exists<br/>18006 - Operation Not Allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/lp/send-sms
\n
Send SMS to user (sendSms)
\n
Use this operation to send an SMS to a login protect user.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on.
email (required)
\n \n
Query Parameter — Email address.
sms_text (required)
\n \n
Query Parameter — Text that will be sent in SMS.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>18003 -Invalid phone number<br/>18011 - Invalid SMS Text<br/>9403 - Unknown/unauthorized account_id<br/>18010 - Invalid User<br/>18007 - Exceeded Allowed SMS<br/>18008 - Failed to Send SMS\n ApiResult\n

SiteManagement

\n
\n \n 
post /api/prov/v1/sites/performance/caching-rules/add
\n
Add a cache rule (addCacheRule)
\n
Use this operation for adding a cache rule
\n\n\n\n\n\n

Query parameters

\n
\n
action (required)
\n \n
Query Parameter — Rule action. See Possible action parameter values.<br/>Possible action parameter values:<br/><ul><li><b>HTTP_CACHE_MAKE_STATIC</b> Cache Resource</li><li><b>HTTP_CACHE_CLIENT_CACHE_CTL</b> Cache Resource on Client</li><li><b>HTTP_CACHE_FORCE_UNCACHEABLE</b> Don't Cache Resource</li><li><b>HTTP_CACHE_DIFFERENTIATE_SSL</b> Differentiate Cache Key by HTTP/HTTPS Scheme</li><li><b>HTTP_CACHE_DIFFERENTIATE_BY_HEADER</b> Differentiate Cache Key by Header</li><li><b>HTTP_CACHE_DIFFERENTIATE_BY_COOKIE</b> Differentiate Cache Key by Cookie</li><li><b>HTTP_CACHE_DIFFERENTIATE_BY_GEO</b> Differentiate Cache Key by Geolocation</li><li><b>HTTP_CACHE_IGNORE_PARAMS</b> Ignore Parameters in Cache Key</li><li><b>HTTP_CACHE_IGNORE_AUTH_HEADER</b> Cache Authenticated Resources</li><li><b>HTTP_CACHE_FORCE_VALIDATION</b> Force User Authentication</li><li><b>HTTP_CACHE_ADD_TAG</b> Create Tag</li><li><b>HTTP_CACHE_ENRICH_CACHE_KEY</b> Enrich Cache Key</li></ul>
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
name (required)
\n \n
Query Parameter — Rule name.
filter (optional)
\n \n
Query Parameter — Rule will trigger only a request that matches this filter. For more details on filters, see <a href="https://docs.imperva.com/csh?context=rule_syntax">Syntax Guide</a>.
ttl (optional)
\n \n
Query Parameter — Rule TTL. Only relevant when action is HTTP_CACHE_MAKE_STATIC or HTTP_CACHE_CLIENT_CACHE_CTL
ttl_unit (optional)
\n \n
Query Parameter — Rule TTL time unit.<br/>Must be one of SECONDS, MINUTES, HOURS, DAYS or WEEKS. If no time unit is provided, SECONDS is used.<br/>Only relevant when action is HTTP_CACHE_MAKE_STATIC or HTTP_CACHE_CLIENT_CACHE_CTL
differentiated_by_value (optional)
\n \n
Query Parameter — Value to differentiate by. HTTP_CACHE_DIFFERENTIATE_BY_HEADER - header name, HTTP_CACHE_DIFFERENTIATE_BY_COOKIE - cookie name, HTTP_CACHE_DIFFERENTIATE_BY_GEO - geo location <br/>(ISO 3166-1 alpha-2 country codes ), otherwise irrelevant.
params (optional)
\n \n
Query Parameter — Comma separated list of parameters to ignore. Parameters name must be alphanumeric.
all_params (optional)
\n \n
Query Parameter — When set to <b>true</b>: all parameters in cache key will be ignored.<br/>Default: false.<br/>Relevant for HTTP_CACHE_IGNORE_PARAMS action
tag_name (optional)
\n \n
Query Parameter — The name of the tag to add.
text (optional)
\n \n
Query Parameter — Add text to the cache key as suffix. Relevant for the HTTP_CACHE_ENRICH_CACHE_KEY action
\n\n\n

Return type

\n
\n inline_response_200_3\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed<br/>2 - Invalid input\n inline_response_200_3\n
\n
\n \n 
post /api/prov/v1/sites/incapRules/add
\n
Add rule (addCustomRule)
\n
Use this operation to add a rule (Delivery, Security or Rate).
\n\n\n\n\n\n

Query parameters

\n
\n
action (required)
\n \n
Query Parameter — Rule action. See the possible values in the table below.<br/>Possible action parameter values for Delivery Rules:<br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li></ul><br/>Possible action parameter values for security rules:<br/><ul><li><b>RULE_ACTION_ALERT</b> Generate a non blocking alert for this event.</li><li><b>RULE_ACTION_BLOCK</b> Block the current request and generate an alert for this event.</li><li><b>RULE_ACTION_BLOCK_USER</b> Block the current session and generate an alert for this event. Any subsequent request from the same Session will be blocked.</li><li><b>RULE_ACTION_BLOCK_IP</b> Block the current session and generate an alert for this event. Any subsequent request from the same Session will be blocked.</li><li><b>RULE_ACTION_RETRY</b> Require any client matching the rule filters to support cookies in order to complete the request.</li><li><b>RULE_ACTION_INTRUSIVE_HTML</b> Require any client matching the rule filters to support javascript in order to complete the request. Since the Javascript test is embedded in an HTML page, this action should only be enabled for HTML resources.</li><li><b>RULE_ACTION_CAPTCHA</b> Require any client matching the rule filters to pass a CAPTCHA test in order to complete the request. Since the CAPTCHA test is embedded in an HTML page, this action should only be enabled for HTML resources.</li></ul><br/>Possible action parameter values for counter (rate) rules:<br/><ul><li><b>RULE_ACTION_RATE</b> Count the number of requests received that match the rule filter.</li></ul>
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
name (required)
\n \n
Query Parameter — Rule name.
filter (required)
\n \n
Query Parameter — Rule will trigger only a request that matches this filter. For more details on filter guidelines, see <a href="https://docs.imperva.com/csh?context=rule_syntax">Syntax Guide</a>.<br/>The filter may contain up to 400 characters.
response_code (optional)
\n \n
Query Parameter — Redirect rule's response code. Valid values are 302, 301, 303, 307, 308. format: int32
protocol (optional)
\n \n
Query Parameter —
add_missing (optional)
\n \n
Query Parameter — Add cookie or header if it doesn't exist (Rewrite cookie rule only)
from (optional)
\n \n
Query Parameter — The pattern to rewrite.<br/>For RULE_ACTION_REWRITE_URL - The URL to rewrite.<br/>For RULE_ACTION_REWRITE_HEADER - The header value to rewrite.<br/>For RULE_ACTION_REWRITE_COOKIE - The cookie value to rewrite.<br/>For RULE_ACTION_SIMPLIFIED_REDIRECT - Redirect the client to a different URL, responding with a 30X response.
to (optional)
\n \n
Query Parameter — The pattern to change to.<br/>For RULE_ACTION_REWRITE_URL - The URL to change to.<br/>For RULE_ACTION_REWRITE_HEADER - The header value to change to.<br/>For RULE_ACTION_REWRITE_COOKIE - The cookie value to change to.<br/>For RULE_ACTION_SIMPLIFIED_REDIRECT - Redirect the client to a different URL, responding with a 30X response.
rewrite_name (optional)
\n \n
Query Parameter — Name of cookie or header to rewrite. Applies only for RULE_ACTION_REWRITE_COOKIE and RULE_ACTION_REWRITE_HEADER.
dc_id (optional)
\n \n
Query Parameter — Data center to forward request to. Applies only for RULE_ACTION_FORWARD_TO_DC. format: int64
allow_caching (optional)
\n \n
Query Parameter —
is_test_mode (optional)
\n \n
Query Parameter — Apply the rule only to the IP address the API request was sent from.<br/>This option is not available for Simplified Redirect rules.
rate_context (optional)
\n \n
Query Parameter — The context of the rate counter. Possible values: IP / Session. Applies only to rules using RULE_ACTION_RATE.
rate_interval (optional)
\n \n
Query Parameter — The interval (in seconds) of the rate counter. Possible values: A multiple of 10 from 10-300. Applies only to rules using RULE_ACTION_RATE. format: int32
port_forwarding_context (optional)
\n \n
Query Parameter — Context for port forwarding. &quot;Use Port Value&quot; or &quot;Use Header Name&quot;. Applies only for RULE_ACTION_FORWARD_TO_PORT.
port_forwarding_value (optional)
\n \n
Query Parameter — Port number or header name for port forwarding. Applies only for RULE_ACTION_FORWARD_TO_PORT.
multiple_deletions (optional)
\n \n
Query Parameter — Delete multiple header occurrences. Applies only to rules using RULE_ACTION_DELETE_HEADER and RULE_ACTION_RESPONSE_DELETE_HEADER.
rewrite_existing (optional)
\n \n
Query Parameter — Rewrite cookie or header if it exists
\n\n\n

Return type

\n
\n CustomRuleResponse\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "rule_id" : 43573,\n  "res" : 0,\n  "status" : "ok"\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input, 3015 - Granularity invalid\n CustomRuleResponse\n
\n
\n \n 
post /api/prov/v1/sites/dataCenters/servers/add
\n
Add server (addDCServer)
\n
Use this operation to add a server to a data center.
\n\n\n\n\n\n

Query parameters

\n
\n
dc_id (required)
\n \n
Query Parameter — The data center's ID. format: int64
server_address (required)
\n \n
Query Parameter — Server IP address.
is_disabled (optional)
\n \n
Query Parameter — Enables the data center
is_standby (optional)
\n \n
Query Parameter — Set the server as Active (P0) or Standby (P1) (Boolean).
\n\n\n

Return type

\n
\n inline_response_200_16\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>1 -General error</br>2- invalid data center\n inline_response_200_16\n
\n
\n \n 
post /api/prov/v1/sites/dataCenters/add
\n
Add data center (addDataCenter)
\n
Use this operation for adding data center to site.
You can configure up to 40 data centers per site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
name (required)
\n \n
Query Parameter — The new data center's name.
server_address (required)
\n \n
Query Parameter — The server's address. Possible values: IP, CNAME
lb_algorithm (optional)
\n \n
Query Parameter — Data center load balancing algorithm. Possible values are:<br/>LB_LEAST_PENDING_REQUESTS - Server with least pending requests<br/>LB_LEAST_OPEN_CONNECTIONS - Server with least open connections<br/>LB_SOURCE_IP_HASH - Server by IP hash<br/>RANDOM - Random server<br/>WEIGHTED - Server by weight
is_enabled (optional)
\n \n
Query Parameter — Enables the data center.
is_content (optional)
\n \n
Query Parameter — The data center will be available for specific resources (<b>Forward</b> Delivery Rules).
\n\n\n

Return type

\n
\n inline_response_200_17\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - a data center with that name already exists\n inline_response_200_17\n
\n
\n \n 
post /api/prov/v1/sites/add
\n
Add a site (addSite)
\n
Add a new site to an account. If the site already exists, its status is returned.
\n\n\n

Consumes

\n This API call consumes the following media types via the Content-Type request header:\n
    \n
  • application/json
    • \n
\n\n

Request body

\n
\n
body string (optional)
\n \n
Body Parameter —
\n
\n\n\n

Query parameters

\n
\n
domain (required)
\n \n
Query Parameter — The domain name of the site. For example: <a href="www.example.com">www.example.com</a>, <a href="hello.example.com">www.example.com</a>, <a href="example.com">www.example.com</a>
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
ref_id (optional)
\n \n
Query Parameter — Customer specific identifier for this operation
send_site_setup_emails (optional)
\n \n
Query Parameter — If this value is false, end users will not get emails about the add site process such as DNS instructions and SSL setup.
site_ip (optional)
\n \n
Query Parameter — Manually set the web server IP/CNAME
force_ssl (optional)
\n \n
Query Parameter — If this value is true, manually set the site to support SSL.<br/>This option is only available for sites with manually configured IP/CNAME and for specific accounts.
naked_domain_san (optional)
\n \n
Query Parameter — Use “true” to add the naked domain SAN to a www site’s SSL certificate. Default value: true
wildcard_san (optional)
\n \n
Query Parameter — Use “true” to add the wildcard SAN or “false” to add the full domain SAN to the site’s SSL certificate. Default value: true
log_level (optional)
\n \n
Query Parameter — Available only for customers that purchased the Logs Integration SKU.<br/>Sets the log reporting level for the site. Options are “full”, “security”, “none” and default
logs_account_id (optional)
\n \n
Query Parameter — Available only for customers that purchased the Logs Integration SKU.<br/>Numeric identifier of the account that purchased the logs integration SKU and which collects the logs.<br/>If not specified, operation will be performed on the account identified by the authentication parameters
\n\n\n

Return type

\n
\n inline_response_200_14\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3001 - Domain invalid<br/>3002 - Site is on the CloudFlare network<br/>3003 - Site requires SSL<br/>3004 - Domain belongs to a known service</br>3005 - Site is on a service<br/>3006 - Site requires multiple IPs support<br/>3011 - Site unresolvable<br/>3012 - Site unreachable<br/>3013 -Site already protected by the service<br/>3014 - Number of allowed sites exceeded.<br/>3015 - Internal error\n inline_response_200_14\n
\n
\n \n 
post /api/prov/v1/caa/check-compliance
\n
Check CAA compliance (checkCAACompliance)
\n
Check site’s associated SANs for CAA compliance. If a given SAN is compliant, its SSL domain validation status is updated accordingly.This operation returns an updated list of the site’s associated SANs that are not compliant. An empty list indicates that all SANs are compliant.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
\n\n\n

Return type

\n
\n CaaComplianceCheckResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "res_message",\n  "non_compliant_sans" : [ "*.caa.incaptest.co", "*.caa.incaptest.co" ]\n}
\n\n

Produces

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

Responses

\n

200

\n Success\n CaaComplianceCheckResult\n
\n
\n \n 
post /api/prov/v1/sites/customCertificate/csr
\n
Create new CSR (createNewCSR)
\n
Use this operation to create a certificate signing request (CSR) for your site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on format: int64
domain (optional)
\n \n
Query Parameter — common name. For example: example.com
email (optional)
\n \n
Query Parameter — Email address. For example: joe@example.com
country (optional)
\n \n
Query Parameter — The two-letter ISO code for the country where your organization is located
state (optional)
\n \n
Query Parameter — The state/region where your organization is located. This should not be abbreviated
city (optional)
\n \n
Query Parameter — The city where your organization is located
organization (optional)
\n \n
Query Parameter — The legal name of your organization. This should not be abbreviated or include suffixes such as Inc., Corp., or LLC
organization_unit (optional)
\n \n
Query Parameter — The division of your organization handling the certificate. For example, IT Department
\n\n\n

Return type

\n
\n CreateNewCSRResponse\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : "0",\n  "csr_content" : "-----BEGIN CERTIFICATE REQUEST-----\\\\nMIIC5DCCAcwCAQAwgZ4xNTAzBgNVBAMTLGEucmV1c2VjdXN0b21jZXJ0aWZpY2F0\\\\nZXdpdGhjc3J0ZXN0MzUzOTYuY29tMQwwCgYDVQQHEwNKRVIxCzAJBgNVBAYTAklM\\\\nMQswCQYDVQQIEwJJTDEQMA4GA1UEChMHaW1wZXJ2YTELMAkGA1UECxMCQ04xHjAc\\\\nBgkqhkiG9w0BCQEWD2Zvb0BpbXBlcnZhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQAD\\\\nggEPADCCAQoCggEBAMAHcUrB5rhio8jaAueo6rdpgW1SuscfiiK01xZF5utOqrQ2\\\\nSfD3IBaQcT6pf9fFT5zUcErXmCpjdabY42JmjiRvS04aKhI4pKydM17e5CSevSyM\\\\n0gAYhUdQOgjpCY81/58RKwndG3diFbsdrGnDuKWf7kLmx/biK+3IIZxSPF7JsQ1i\\\\nDHzS9X1Sq3Hwk7GBwOLBlKqG6VXS3SMUReggW6VJhuCKlY+FPUuT7Qr80fkfVt8x\\\\nbCFle7gMF8v390Tc36FFXF7/Jo5m9aSgFLFPRPsbJ+UlRxvRXrnLNm+ycCcXvL5A\\\\ngE50PJaCHJz4U45c9zSAKbrvGHKzZ6eWkdVCDfsCAwEAAaAAMA0GCSqGSIb3DQEB\\\\nCwUAA4IBAQAvRrtUP86lG3J+uYrtnvZzDGRue6eIVwfDOKqrPBAX3fm+JnctZKC5\\\\nQVmLToMFKRyL/FsF3K4a9hf8pN5TjT2/LS7OvgOHOfQC0eZCcocRmz++MtUaQxsx\\\\n+WHiUkpgnXnH3KQhj3WzP6HJV/qjRzcRWBsHUhuE75/J0153RWEXQssC5y4t3hvl\\\\nynkT6BUkQDy8XdRA3kgahPd9Jnwx4be9pRuq7hw1JIA7jFqu4A/ZSoUAoCqgWIfD\\\\nXSt26/4tt4DItt+G/SLGNPuhuc2z+VmGkDDrRm8SNfykEvHFlKkdYcSKgLH2+fgf\\\\nlCCHPIALjavOirG+cki5Ppc0M/Wmagl+\\\\n-----END CERTIFICATE REQUEST-----\\\\n",\n  "status" : "ok"\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>4205 - Site does not have SSL<br/>9414 - Feature not permitted<br/>9414 - Feature not permitted</br>3015 - Internal error\n CreateNewCSRResponse\n
\n
\n \n 
post /api/prov/v1/sites/performance/caching-rules/delete
\n
Delete a cache rule (deleteCacheRule)
\n
Use this operation for deleting a cache rule
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
rule_id (required)
\n \n
Query Parameter — ID of the rule to change. format: int64
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed<br/>2 - Invalid input<br/>2002 - Object is not found<br/>1 - Unexpected error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/incapRules/delete
\n
Delete rule (deleteCustomRule)
\n
Use this operation to delete a rule (Delivery, Security or Rate).
\n\n\n\n\n\n

Query parameters

\n
\n
rule_id (required)
\n \n
Query Parameter — Rule id format: int64
\n\n\n

Return type

\n
\n DeleteCustomRuleResponse\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "status" : "ok"\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/> 2 - Timerange invalid, 9413 - Unknown/unauthorized site_id\n DeleteCustomRuleResponse\n
\n
\n \n 
post /api/prov/v1/sites/dataCenters/servers/delete
\n
Delete server (deleteDCServer)
\n
Use this operation to delete a data center's server.
\n\n\n\n\n\n

Query parameters

\n
\n
server_id (required)
\n \n
Query Parameter — Server ID. format: int64
\n\n\n

Return type

\n
\n inline_response_200_16\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9415 -invalid.server.state</br>2- invalid data center<br/>1 - Unexpected error\n inline_response_200_16\n
\n
\n \n 
post /api/prov/v1/sites/dataCenters/delete
\n
Delete data center (deleteDataCenter)
\n
Use this operation to delete a site's data center.
\n\n\n\n\n\n

Query parameters

\n
\n
dc_id (required)
\n \n
Query Parameter — The data center's ID. format: int64
\n\n\n

Return type

\n
\n inline_response_200_17\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>5 -Could not delete data center</br>2- invalid data center</br>9415- invalid.dc.state<br/>3011 - There must be at least one active data center not configured for forward rules in the site\n inline_response_200_17\n
\n
\n \n 
post /api/prov/v1/sites/delete
\n
Delete site (deleteSite)
\n
Delete the site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (optional)
\n \n
Query Parameter — Numeric identifier of the site to operate on
ignore_grace_period (optional)
\n \n
Query Parameter — The process ignores the site’s 24 hour grace period and immediately deletes the site. Default value: false
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>1 - Unexpected error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/domain/emails
\n
Get domain approver e-mail addresses (domainEmails)
\n
Use this operation to get the list of email addresses that can be used when adding an SSL site.
\n\n\n\n\n\n

Query parameters

\n
\n
domain (required)
\n \n
Query Parameter — The domain name of the site. For example: <a href="www.example.com">www.example.com</a>, <a href="hello.example.com">www.example.com</a>, <a href="example.com">www.example.com</a>
\n\n\n

Return type

\n
\n inline_response_200_30\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3001 - Domain invalid<br/>3011 - Site unresolvable\n inline_response_200_30\n
\n
\n \n 
post /api/prov/v3/sites/{extSiteId}/settings/botConfiguration
\n
Update website bot configuration (editBotsConfiguration)
\n
Update the Bot Access Control configuration for a given website.
For the full list of client applications and their associated IDs, see Client Classification.
\n\n

Path parameters

\n
\n
extSiteId (required)
\n \n
Path Parameter — format: int64
\n\n

Consumes

\n This API call consumes the following media types via the Content-Type request header:\n
    \n
  • application/json
    • \n
\n\n

Request body

\n
\n
body BotsConfigurationDTO (required)
\n \n
Body Parameter — JSON body. <br> Note: displayName is relevant for response only.
\n
\n\n\n\n\n

Return type

\n
\n BotsConfigurationDTO\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "data" : [ {\n    "badBots" : [ null, null ],\n    "canceledGoodBots" : [ {\n      "displayName" : "Googlebot (Search Bot)",\n      "id" : 6\n    }, {\n      "displayName" : "Googlebot (Search Bot)",\n      "id" : 6\n    } ]\n  }, {\n    "badBots" : [ null, null ],\n    "canceledGoodBots" : [ {\n      "displayName" : "Googlebot (Search Bot)",\n      "id" : 6\n    }, {\n      "displayName" : "Googlebot (Search Bot)",\n      "id" : 6\n    } ]\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n OK\n BotsConfigurationDTO\n

401

\n Unauthorized\n ApiErrorResponse\n

404

\n Not Found\n ApiErrorResponse\n

406

\n Not Acceptable\n ApiErrorResponse\n

500

\n Server Error\n ApiErrorResponse\n
\n
\n \n 
post /api/prov/v1/sites/performance/caching-rules/edit
\n
Edit a cache rule (editCacheRule)
\n
Use this operation for editing a cache rule
\n\n\n\n\n\n

Query parameters

\n
\n
action (required)
\n \n
Query Parameter — Rule action. See Possible action parameter values.<br/>Possible action parameter values:<br/><ul><li><b>HTTP_CACHE_MAKE_STATIC</b> Cache Resource</li><li><b>HTTP_CACHE_CLIENT_CACHE_CTL</b> Cache Resource on Client</li><li><b>HTTP_CACHE_FORCE_UNCACHEABLE</b> Don't Cache Resource</li><li><b>HTTP_CACHE_DIFFERENTIATE_SSL</b> Differentiate Cache Key by HTTP/HTTPS Scheme</li><li><b>HTTP_CACHE_DIFFERENTIATE_BY_HEADER</b> Differentiate Cache Key by Header</li><li><b>HTTP_CACHE_DIFFERENTIATE_BY_COOKIE</b> Differentiate Cache Key by Cookie</li><li><b>HTTP_CACHE_DIFFERENTIATE_BY_GEO</b> Differentiate Cache Key by Geolocation</li><li><b>HTTP_CACHE_IGNORE_PARAMS</b> Ignore Parameters in Cache Key</li><li><b>HTTP_CACHE_IGNORE_AUTH_HEADER</b> Cache Authenticated Resources</li><li><b>HTTP_CACHE_FORCE_VALIDATION</b> Force User Authentication</li><li><b>HTTP_CACHE_ADD_TAG</b> Create Tag</li><li><b>HTTP_CACHE_ENRICH_CACHE_KEY</b> Enrich Cache Key</li></ul>
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
rule_id (required)
\n \n
Query Parameter — ID of the rule to change. format: int64
name (required)
\n \n
Query Parameter — Rule name.
filter (optional)
\n \n
Query Parameter — Rule will trigger only a request that matches this filter. For more details on filters, see <a href="https://docs.imperva.com/csh?context=rule_syntax">Syntax Guide</a>.
ttl (optional)
\n \n
Query Parameter — Rule TTL. Only relevant when action is HTTP_CACHE_MAKE_STATIC or HTTP_CACHE_CLIENT_CACHE_CTL
ttl_unit (optional)
\n \n
Query Parameter — Rule TTL time unit.<br/>Must be one of SECONDS, MINUTES, HOURS, DAYS or WEEKS. If no time unit is provided, SECONDS is used.<br/>Only relevant when action is HTTP_CACHE_MAKE_STATIC or HTTP_CACHE_CLIENT_CACHE_CTL
differentiated_by_value (optional)
\n \n
Query Parameter — Value to differentiate by. HTTP_CACHE_DIFFERENTIATE_BY_HEADER - header name, HTTP_CACHE_DIFFERENTIATE_BY_COOKIE - cookie name, HTTP_CACHE_DIFFERENTIATE_BY_GEO - geo location<br/> (ISO 3166-1 alpha-2 country codes ), otherwise irrelevant.
params (optional)
\n \n
Query Parameter — Comma separated list of parameters to ignore. Parameters name must be alphanumeric.
all_params (optional)
\n \n
Query Parameter — When set to <b>true</b>: all parameters in cache key will be ignored.<br/>Default: false.<br/>Relevant for HTTP_CACHE_IGNORE_PARAMS action
tag_name (optional)
\n \n
Query Parameter — The name of the tag to add.
text (optional)
\n \n
Query Parameter — Add text to the cache key as suffix. Relevant for the HTTP_CACHE_ENRICH_CACHE_KEY action
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed<br/>2 - Invalid input<br/>2002 - Object is not found\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/incapRules/edit
\n
Edit rule (editCustomRule)
\n
Use this operation to edit an existing rule (Delivery, Security or Rate).
\n\n\n\n\n\n

Query parameters

\n
\n
action (optional)
\n \n
Query Parameter — Rule action.<br/><br/>Possible action parameter values for Delivery Rules:<br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li></ul><br/>Possible action parameter values for security rules:<br/><ul><li><b>RULE_ACTION_ALERT</b> Generate a non blocking alert for this event.</li><li><b>RULE_ACTION_BLOCK</b> Block the current request and generate an alert for this event.</li><li><b>RULE_ACTION_BLOCK_USER</b> Block the current session and generate an alert for this event. Any subsequent request from the same Session will be blocked.</li><li><b>RULE_ACTION_BLOCK_IP</b> Block the current session and generate an alert for this event. Any subsequent request from the same Session will be blocked.</li><li><b>RULE_ACTION_RETRY</b> Require any client matching the rule filters to support cookies in order to complete the request.</li><li><b>RULE_ACTION_INTRUSIVE_HTML</b> Require any client matching the rule filters to support javascript in order to complete the request. Since the Javascript test is embedded in an HTML page, this action should only be enabled for HTML resources.</li><li><b>RULE_ACTION_CAPTCHA</b> Require any client matching the rule filters to pass a CAPTCHA test in order to complete the request. Since the CAPTCHA test is embedded in an HTML page, this action should only be enabled for HTML resources.</li></ul><br/>Possible action parameter values for counter (rate) rules:<br/><ul><li><b>RULE_ACTION_RATE</b> Count the number of requests received that match the rule filter.</li></ul>
rule_id (required)
\n \n
Query Parameter — Rule ID. format: int64
name (optional)
\n \n
Query Parameter — Rule name.
filter (optional)
\n \n
Query Parameter — Rule will trigger only a request that matches this filter. For more details on filter guidelines, see <a href="https://docs.imperva.com/csh?context=rule_syntax">Syntax Guide</a>.
response_code (optional)
\n \n
Query Parameter — Redirect rule's response code. Valid values are 302, 301, 303, 307, 308. format: int32
protocol (optional)
\n \n
Query Parameter —
add_missing (optional)
\n \n
Query Parameter — Add cookie or header if it doesn't exist (Rewrite cookie rule only)
from (optional)
\n \n
Query Parameter — The pattern to rewrite.<br/>For RULE_ACTION_REWRITE_URL - The URL to rewrite.<br/>For RULE_ACTION_REWRITE_HEADER - The header value to rewrite.<br/>For RULE_ACTION_REWRITE_COOKIE - The cookie value to rewrite.<br/>For RULE_ACTION_SIMPLIFIED_REDIRECT - Redirect the client to a different URL, responding with a 30X response.
to (optional)
\n \n
Query Parameter — The pattern to change to.<br/>For RULE_ACTION_REWRITE_URL - The URL to change to.<br/>For RULE_ACTION_REWRITE_HEADER - The header value to change to.<br/>For RULE_ACTION_REWRITE_COOKIE - The cookie value to change to.<br/>For RULE_ACTION_SIMPLIFIED_REDIRECT - Redirect the client to a different URL, responding with a 30X response.
rewrite_name (optional)
\n \n
Query Parameter — Name of cookie or header to rewrite. Applies only for RULE_ACTION_REWRITE_COOKIE and RULE_ACTION_REWRITE_HEADER.
dc_id (optional)
\n \n
Query Parameter — Data center to forward request to. Applies only for RULE_ACTION_FORWARD_TO_DC. format: int64
allow_caching (optional)
\n \n
Query Parameter —
rate_context (optional)
\n \n
Query Parameter — The context of the rate counter. Possible values: IP / Session. Applies only to rules using RULE_ACTION_RATE.
rate_interval (optional)
\n \n
Query Parameter — The interval (in seconds) of the rate counter. Possible values: A multiple of 10 from 10-300. Applies only to rules using RULE_ACTION_RATE. format: int32
is_test_mode (optional)
\n \n
Query Parameter — Make rule apply only for IP address the API request was sent from.<br/>This option is not available for Simplified Redirect rules.
port_forwarding_context (optional)
\n \n
Query Parameter — Context for port forwarding. &quot;Use Port Value&quot; or &quot;Use Header Name&quot;. Applies only for RULE_ACTION_FORWARD_TO_PORT.
port_forwarding_value (optional)
\n \n
Query Parameter — Port number or header name for port forwarding. Applies only for RULE_ACTION_FORWARD_TO_PORT.
multiple_deletions (optional)
\n \n
Query Parameter — Delete multiple header occurrences. Applies only to rules using RULE_ACTION_DELETE_HEADER and RULE_ACTION_RESPONSE_DELETE_HEADER.
rewrite_existing (optional)
\n \n
Query Parameter — Rewrite cookie or header if it exists
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/> 2 - Timerange invalid, 9413 - Unknown/unauthorized site_id<br/> 9415 - Operation not allowed<br/> 3015 - Internal error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/dataCenters/servers/edit
\n
Edit server (editDCServer)
\n
Use this operation to edit a server in a data center.
\n\n\n\n\n\n

Query parameters

\n
\n
server_id (required)
\n \n
Query Parameter — Server ID. format: int64
server_address (optional)
\n \n
Query Parameter — The IP address of the server to modify.
is_enabled (optional)
\n \n
Query Parameter — Enable or disable the server (Boolean).
is_standby (optional)
\n \n
Query Parameter — Set the server as Active (P0) or Standby (P1) (Boolean).
\n\n\n

Return type

\n
\n inline_response_200_16\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9415 -invalid.server.state</br>2- invalid data center<br/>1 -Unexpected error<br/>9413 -invalid server<br/>1 -General error\n inline_response_200_16\n
\n
\n \n 
post /api/prov/v1/sites/dataCenters/edit
\n
Edit data center (editDataCenter)
\n
Use this operation to edit site's data center.
\n\n\n\n\n\n

Query parameters

\n
\n
dc_id (required)
\n \n
Query Parameter — The data center's ID. format: int64
name (optional)
\n \n
Query Parameter — The new data center's name.
is_enabled (optional)
\n \n
Query Parameter — Enables the data center.
is_standby (optional)
\n \n
Query Parameter — Defines the data center as <b>standby</b> for failover.
is_content (optional)
\n \n
Query Parameter — The data center will be available for specific resources (<b>Forward</b> Delivery Rules).
\n\n\n

Return type

\n
\n inline_response_200_17\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 -invalid data center</br>2- data center with that name already exists\n inline_response_200_17\n
\n
\n \n 
post /api/prov/v1/sites/performance/cache-shield/enable
\n
Enable cache shield (enableCacheShield)
\n
Enable Cache Shield for a given site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
enable (required)
\n \n
Query Parameter — Use <b>true</b> to enable cache shield on the specified site, and <b>false</b> to disable it.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>1 - Unexpected error<br/>405 - Api is disabled\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/performance/caching-rules/enable
\n
Enable or disable cache rule (enableDisableCacheRule)
\n
Use this operation for enabling or disable cache rule
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
rule_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
enable (required)
\n \n
Query Parameter — When true, the rule will be enabled. Set to false to disable.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed<br/>2 - Invalid input<br/>2002 - Object is not found\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/incapRules/enableDisable
\n
Enable or disable rule (enableDisableCustomRule)
\n
Use this operation to enable or disable a rule (Delivery, Security or Rate).
\n\n\n\n\n\n

Query parameters

\n
\n
rule_id (required)
\n \n
Query Parameter — Rule id format: int64
enable (required)
\n \n
Query Parameter — When true, the rule will be enabled. Set to false to disable
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/> 2 - Timerange invalid, 9413 - Unknown/unauthorized site_id<br/> 9415 - Operation not allowed<br/> 3015 - Internal error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/performance/advanced/get
\n
Get advanced caching settings (getAdvancedCachingSettings)
\n
Use this operation to get advanced caching settings.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
param (required)
\n \n
Query Parameter — Name of configuration parameter to set.<br/>Possible values for param and value parameters:<br/><ul><li><b>async_validation</b> Sets Async validation. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>minify_javascript</b> Sets the Minify JS. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>minify_css</b> Sets the Minify CSS. Pass &quot;true&quot; or &quot;false&quot; in the value parameter</li><li><b>minify_static_html</b> Sets Minify static HTML. Pass &quot;true&quot; or &quot;false&quot; in the value parameter</li><li><b>compress_jpeg</b> Sets the Compress JPEG. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>progressive_image_rendering</b> Sets the Progressive Image rendering flag. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>aggressive_compression</b> Sets the Aggressive compression rendering flag. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>compress_png</b> Sets the Compress PNG flag. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>on_the_fly_compression</b> &quot;On the fly&quot; Compression. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>tcp_pre_pooling</b> TCP Pre-Pooling. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>comply_no_cache</b> Comply with no-cache and max-age directives in client requests. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>comply_vary</b> Comply with the <b>Vary</b> header. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>use_shortest_caching</b> Use shortest caching duration in case of conflicts. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>prefer_last_modified</b> Prefer 'last modified' over eTag. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>disable_client_side_caching</b> Disable client side caching. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>cache_300x</b> Cache 300X responses. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>unite_naked_full_cache</b> Use the same cache for full and naked domains. For example, use the same cached resource for <a href="https://www.example.com/a"></a> and <a href="https://example.com/"></a>a.</li><li><b>cache_empty_responses</b> Cache responses that don’t have a message body.</li><li><b>cache_http_10_responses</b> Cache HTTP 1.0 type responses that don’t include the Content-Length header or chunking. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>send_age_header</b> Send <b>Cache-Control: max-age</b> and <b>Age</b> headers. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>support_non_sni_clients</b> Enable or disable the support for Non-SNI clients for TLS connections between clients and Imperva. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>origin_connection_reuse</b> Requests from multiple client connections may be transmitted through a single TCP connection to the origin, while requests from a single client connection may be distributed across multiple TCP connections to the origin. This option disables that behavior.. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>redirect_http_to_https</b> Redirect HTTP requests to HTTPS requests by sending an HTTP 301 response.</li><li><b>redirect_naked_domain_to_full</b> Redirect requests from your website's naked domain to its full domain by sending and HTTP 301 response.</li><li><b>http_2</b> Enables supporting browsers to take advantage of the performance enhancements provided by HTTP/2 for your website. Non-supporting browsers can connect via HTTP/1.0 or HTTP/1.1. HTTP/2 support requires that SSL is configured for your website. Pass &quot;true&quot; or &quot;false&quot; in the value parameter</li></ul>
\n\n\n

Return type

\n
\n inline_response_200_20\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id\n inline_response_200_20\n
\n
\n \n 
get /api/prov/v3/sites/{extSiteId}/settings/botConfiguration
\n
Get website bot configuration (getBotsConfiguration)
\n
Retrieve the Bot Access Control configuration for a given website.
\n\n

Path parameters

\n
\n
extSiteId (required)
\n \n
Path Parameter — format: int64
\n\n\n\n\n\n\n

Return type

\n
\n BotsConfigurationDTO\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "data" : [ {\n    "badBots" : [ null, null ],\n    "canceledGoodBots" : [ {\n      "displayName" : "Googlebot (Search Bot)",\n      "id" : 6\n    }, {\n      "displayName" : "Googlebot (Search Bot)",\n      "id" : 6\n    } ]\n  }, {\n    "badBots" : [ null, null ],\n    "canceledGoodBots" : [ {\n      "displayName" : "Googlebot (Search Bot)",\n      "id" : 6\n    }, {\n      "displayName" : "Googlebot (Search Bot)",\n      "id" : 6\n    } ]\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n OK\n BotsConfigurationDTO\n

401

\n Unauthorized\n ApiErrorResponse\n

404

\n Not Found\n ApiErrorResponse\n

500

\n Server Error\n ApiErrorResponse\n
\n
\n \n 
post /api/prov/v1/sites/performance/cache404
\n
Get cache 404 settings (getCache404Settings)
\n
Use this operation to get the caching settings of 404 responses for a site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
\n\n\n

Return type

\n
\n inline_response_200_21\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n inline_response_200_21\n
\n
\n \n 
post /api/prov/v1/sites/performance/cache-mode/get
\n
Get caching mode (getCachingMode)
\n
Use this operation to get a site's caching mode.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
\n\n\n

Return type

\n
\n inline_response_200_22\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id\n inline_response_200_22\n
\n
\n \n 
post /api/prov/v1/sites/data-privacy/show
\n
Get site data storage region (getDataRegion)
\n
Use this operation to get the site data region.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
\n\n\n

Return type

\n
\n inline_response_200_31\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9415 - Operation not allowed<br/>14002 - No region for account\n inline_response_200_31\n
\n
\n \n 
post /api/prov/v1/sites/htmlinjections
\n
Get HTML injection rules (getHtmlInjectionRules)
\n
Use this operation to list all the HTML Injection rules
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
\n\n\n

Return type

\n
\n inline_response_200_32\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n Success\n inline_response_200_32\n
\n
\n \n 
post /api/prov/v1/sites/data-privacy/show-override-by-geo
\n
Check Site Regions by Origin Geolocation (getOverrideSiteRegionsByGeo)
\n
Use this operation to check if the data storage region for each new site is based on the geolocation of the origin server.
\n\n\n\n\n\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n Success\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/datacenter/origin-pop/recommend
\n
Get data center recommended origin PoPs (getRecommendedDataCenterOriginPoPs)
\n
Get a list of recommended origin PoPs for a given data center.
\n\n\n\n\n\n

Query parameters

\n
\n
dc_id (required)
\n \n
Query Parameter — Numeric identifier of the data center to operate on. format: int64
\n\n\n

Return type

\n
\n inline_response_200_18\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>405 - Api is disabled</br>2- invalid data center<br/>5 - Cant set Origin PoP for datacenter\n inline_response_200_18\n
\n
\n \n 
post /api/prov/v1/sites/performance/response-headers/get
\n
Get cached response headers (getResponseHeaderSettings)
\n
Use this operation to get a site's cached response headers.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
\n\n\n

Return type

\n
\n inline_response_200_23\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed<br/>5 - Operation is unavailable\n inline_response_200_23\n
\n
\n \n 
post /api/prov/v1/sites/performance/rewrite-port
\n
Get rewrite port (getRewritePorts)
\n
Use this operation to get the rewritten port number used to access the origin server.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
\n\n\n

Return type

\n
\n inline_response_200_24\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n inline_response_200_24\n
\n
\n \n 
post /api/prov/v1/sites/performance/secure-resources/get
\n
Get secure resources mode (getSecureResourcesMode)
\n
Use this operation to get the Secure Resources mode for a site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
\n\n\n

Return type

\n
\n inline_response_200_25\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n inline_response_200_25\n
\n
\n \n 
post /api/prov/v1/sites/performance/error-page
\n
Get error page (getSiteErrorPageTemplate)
\n
Use this operation to get the custom error page for a given site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/report
\n
Get site report (getSiteReport)
\n
Use this operation to get a report for a site. Reports are sent using Base64 encoding.The time_range parameter is ignored for accounts with the WAF Rules policy feature. For such accounts, the report returns the current status.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
report (required)
\n \n
Query Parameter — The report to get. One of: pci-compliance
format (required)
\n \n
Query Parameter — The format to get the report in. One of: pdf | html
time_range (required)
\n \n
Query Parameter — Time range to fetch data for.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul>
start (optional)
\n \n
Query Parameter — Start date in milliseconds since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul>
end (optional)
\n \n
Query Parameter — End date in milliseconds since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul>
\n\n\n

Return type

\n
\n inline_response_200_33\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>5001 - Report invalid<br/>5002 - Format invalid\n inline_response_200_33\n
\n
\n \n 
post /api/prov/v1/sites/performance/stale-content/get
\n
Get stale content settings (getStaleContent)
\n
When Imperva can't connect to the origin server, serve stale content instead of displaying an error to end users for the specified amount of time. Expired resources are returned from cache, and refreshed asynchronously in the background.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
\n\n\n

Return type

\n
\n inline_response_200_26\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n inline_response_200_26\n
\n
\n \n 
get /api/prov/v3/sites/{extSiteId}/settings/TLSConfiguration
\n
Get website TLS configuration (getTLSConfiguration)
\n
Retrieve the TLS configuration for a given website.
\n\n

Path parameters

\n
\n
extSiteId (required)
\n \n
Path Parameter — The Imperva ID of the website to operate on. format: int64
\n\n\n\n\n\n\n

Return type

\n
\n TLSConfigurationDto\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "data" : [ {\n    "hstsConfiguration" : {\n      "maxAge" : 7543,\n      "isEnabled" : false,\n      "subDomainsIncluded" : false,\n      "preLoaded" : false\n    }\n  }, {\n    "hstsConfiguration" : {\n      "maxAge" : 7543,\n      "isEnabled" : false,\n      "subDomainsIncluded" : false,\n      "preLoaded" : false\n    }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n OK\n TLSConfigurationDto\n

401

\n Unauthorized\n ApiErrorResponse\n

404

\n Not Found\n ApiErrorResponse\n

500

\n Server Error\n ApiErrorResponse\n
\n
\n \n 
post /api/prov/v1/sites/performance/tag-response/get
\n
Get header to tag responses by (getTagResponseHeader)
\n
Get the origin response header containing the cache tags in your resources
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
\n\n\n

Return type

\n
\n inline_response_200_27\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n inline_response_200_27\n
\n
\n \n 
post /api/prov/v1/sites/xray/get-link
\n
Get XRay access link (getXrayLink)
\n
Use this operation to get a URL that enables debug headers on the specific site. For more details see XRAY Debug Headers Guide
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
\n\n\n

Return type

\n
\n inline_response_200_28\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>1 - Unexpected error\n inline_response_200_28\n
\n
\n \n 
post /api/prov/v1/sites/performance/cache-shield
\n
Is cache shield enabled (isCacheShieldEnabled)
\n
Get the enablement state of the Cache Shield feature for a given site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
\n\n\n

Return type

\n
\n inline_response_200_29\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n inline_response_200_29\n
\n
\n \n 
post /api/prov/v1/sites/performance/caching-rules/list
\n
List cache rules for a given site (listCacheRules)
\n
Use this operation for representing cache rules for a given site
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
page_size (optional)
\n \n
Query Parameter — The number of objects to return in the response.<br/>Default is 50.<br/>Maximum: 100
page_num (optional)
\n \n
Query Parameter — The page to return starting from 0. Default is 0.
\n\n\n

Return type

\n
\n inline_response_200_4\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed<br/>2 - Invalid input<br/>\n inline_response_200_4\n
\n
\n \n 
post /api/prov/v1/sites/incapRules/list
\n
List rules (listCustomRules)
\n
Use this operation to list security, delivery, and rate rules for a given site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
include_incap_rules (optional)
\n \n
Query Parameter — Whether or not security rules be included. Defaults to &quot;Yes&quot;.
include_ad_rules (optional)
\n \n
Query Parameter — Whether or not delivery rules should be included. Defaults to Yes
page_size (optional)
\n \n
Query Parameter — The number of objects to return in the response. Defaults to 50. Maximum is 100
page_num (optional)
\n \n
Query Parameter — The page to return starting from 0. Default to 0
\n\n\n

Return type

\n
\n ListCustomRulesResponse\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "rate_rules" : {\n    "Rates" : [ {\n      "id" : "4723",\n      "enabled" : "true",\n      "interval" : "120",\n      "name" : "Test Rate IP",\n      "context" : "IP",\n      "action" : "RULE_ACTION_RATE",\n      "internal_name" : "test-rate-ip",\n      "filter" : "ASN == 2"\n    } ]\n  },\n  "delivery_rules" : {\n    "Redirect" : [ {\n      "to" : "/home.php",\n      "id" : "3648",\n      "priority" : "1",\n      "last_7_days_requests_count" : "0",\n      "name" : "Test new",\n      "action" : "RULE_ACTION_REWRITE_URL",\n      "from" : "*/home.html",\n      "filter" : "ASN == 1"\n    } ],\n    "Forward" : [ {\n      "id" : "3628",\n      "priority" : "2",\n      "last_7_days_requests_count" : "0",\n      "name" : "move to rewrite",\n      "dc_id" : "54313",\n      "action" : "RULE_ACTION_FORWARD_TO_DC",\n      "filter" : ""\n    } ]\n  },\n  "incap_rules" : {\n    "All" : [ {\n      "id" : "3660",\n      "last_7_days_requests_count" : "0",\n      "name" : "Ortal",\n      "action" : "RULE_ACTION_ALERT",\n      "filter" : ""\n    } ]\n  }\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input, 9413 - Unknown/unauthorized site_id\n ListCustomRulesResponse\n
\n
\n \n 
post /api/prov/v1/sites/dataCenters/list
\n
List data centers (listDataCenters)
\n
Use this operation to list a site's data centers including the data centers' servers.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
\n\n\n

Return type

\n
\n inline_response_200_19\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - invalid site</br>2 - invalid data center<br/>\n inline_response_200_19\n
\n
\n \n 
get /api/prov/v3/sites/{extSiteId}/data-centers-configuration
\n
get site's data centers' configuration (listDataCentersConfiguration)
\n
Use this operation to get configured data centers and all their servers
\n\n

Path parameters

\n
\n
extSiteId (required)
\n \n
Path Parameter — format: int64
\n\n\n\n\n\n\n

Return type

\n
\n DataCentersConfigurationDTO\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "data" : [ {\n    "lbAlgorithm" : "GEO_PREFERRED",\n    "dataCenterMode" : "MULTIPLE_DC",\n    "kickStartPass" : "kickstart-pass",\n    "kickStartURL" : "https://www.example.com:443/kickStart",\n    "isPersistent" : false,\n    "dataCenters" : [ {\n      "lbAlgorithm" : "WEIGHTED",\n      "isContent" : true,\n      "weight" : 40,\n      "isRestOfTheWorld" : true,\n      "isActive" : false,\n      "geoLocations" : [ "AFRICA", "AFRICA" ],\n      "ipMode" : "MULTIPLE_IP",\n      "servers" : [ {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      }, {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      } ],\n      "originPop" : "lax",\n      "isEnabled" : false,\n      "name" : "London DC",\n      "id" : 7543,\n      "webServersPerServer" : 5\n    }, {\n      "lbAlgorithm" : "WEIGHTED",\n      "isContent" : true,\n      "weight" : 40,\n      "isRestOfTheWorld" : true,\n      "isActive" : false,\n      "geoLocations" : [ "AFRICA", "AFRICA" ],\n      "ipMode" : "MULTIPLE_IP",\n      "servers" : [ {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      }, {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      } ],\n      "originPop" : "lax",\n      "isEnabled" : false,\n      "name" : "London DC",\n      "id" : 7543,\n      "webServersPerServer" : 5\n    } ],\n    "kickStartUser" : "kickstart-user",\n    "minAvailableServersForDataCenterUp" : 3,\n    "failOverRequiredMonitors" : "MANY"\n  }, {\n    "lbAlgorithm" : "GEO_PREFERRED",\n    "dataCenterMode" : "MULTIPLE_DC",\n    "kickStartPass" : "kickstart-pass",\n    "kickStartURL" : "https://www.example.com:443/kickStart",\n    "isPersistent" : false,\n    "dataCenters" : [ {\n      "lbAlgorithm" : "WEIGHTED",\n      "isContent" : true,\n      "weight" : 40,\n      "isRestOfTheWorld" : true,\n      "isActive" : false,\n      "geoLocations" : [ "AFRICA", "AFRICA" ],\n      "ipMode" : "MULTIPLE_IP",\n      "servers" : [ {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      }, {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      } ],\n      "originPop" : "lax",\n      "isEnabled" : false,\n      "name" : "London DC",\n      "id" : 7543,\n      "webServersPerServer" : 5\n    }, {\n      "lbAlgorithm" : "WEIGHTED",\n      "isContent" : true,\n      "weight" : 40,\n      "isRestOfTheWorld" : true,\n      "isActive" : false,\n      "geoLocations" : [ "AFRICA", "AFRICA" ],\n      "ipMode" : "MULTIPLE_IP",\n      "servers" : [ {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      }, {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      } ],\n      "originPop" : "lax",\n      "isEnabled" : false,\n      "name" : "London DC",\n      "id" : 7543,\n      "webServersPerServer" : 5\n    } ],\n    "kickStartUser" : "kickstart-user",\n    "minAvailableServersForDataCenterUp" : 3,\n    "failOverRequiredMonitors" : "MANY"\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n OK\n DataCentersConfigurationDTO\n

401

\n Unauthorized. E.g. Wrong API key, locked user\n ApiErrorResponse\n

403

\n Forbidden. E.g. Missing abilities\n ApiErrorResponse\n

404

\n Not Found. E.g. Site doesn't exist or belongs to other tenant\n ApiErrorResponse\n

500

\n Server Error\n ApiErrorResponse\n
\n
\n \n 
get /api/prov/v3/sites/{extSiteId}/delivery-rules-configuration
\n
Get site’s delivery rule priority order for a specific rule category. (listDeliveryRulesConfiguration)
\n
Use this operation to list all delivery rules of a specific category. The rules are prioritized by order of appearance.
\n\n

Path parameters

\n
\n
extSiteId (required)
\n \n
Path Parameter — Numeric identifier of the site to operate on. format: int64
\n\n\n\n\n

Query parameters

\n
\n
category (required)
\n \n
Query Parameter — Rules category. Possible values:<br>\n<b>REDIRECT</b> - Redirect requests with 30X response.<br>\n<b>SIMPLIFIED_REDIRECT</b> - Redirect requests with 30X response. (static redirect, doesn't support condition)<br>\n<b>REWRITE</b> - Modify, add, and remove different request attributes such as URL, headers and cookies.<br>\n<b>REWRITE_RESPONSE</b> - Modify, add, and remove different response attributes such as headers, status code and error responses.<br>\n<b>FORWARD</b> - Forward the request to a specific data-center or port.
\n\n\n\n \n\n\n

Produces

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

Responses

\n

200

\n OK\n \n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_FORWARD_TO_PORT (ForwardToPortRuleDTO),
RULE_ACTION_FORWARD_TO_DC (ForwardToDcRuleDTO)
\n 
{"data":[{"filter":"ASN == 1","dc_id":1234,"rule_name":"New delivery rule","action":"RULE_ACTION_FORWARD_TO_DC","enabled":true},{"filter":"ASN == 1","port_forwarding_context":"[header/port]","port_forwarding_value":"1234","rule_name":"New delivery rule","action":"RULE_ACTION_FORWARD_TO_PORT","enabled":true}]}
\n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_REDIRECT (RedirectRuleDTO)
\n 
{"data":[{"filter":"ASN == 1","from":"/1","to":"/2","response_code":302,"rule_name":"New delivery rule","action":"RULE_ACTION_REDIRECT","enabled":true}]}
\n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_SIMPLIFIED_REDIRECT (SimplifiedRedirectRuleDTO)
\n 
{"data":[{"from":"/1","to":"/2","response_code":302,"rule_name":"New delivery rule","action":"RULE_ACTION_REDIRECT","enabled":true}]}
\n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_REWRITE_COOKIE (RewriteRequestCookieRuleDTO),
RULE_ACTION_REWRITE_HEADER (RewriteRequestHeaderRuleDTO),
RULE_ACTION_REWRITE_URL (RewriteRequestUrlRuleDTO),
RULE_ACTION_DELETE_HEADER (RewriteRequestDeleteHeaderRuleDTO),
RULE_ACTION_DELETE_COOKIE (RewriteRequestDeleteCookieRuleDTO)
\n 
{"data":[{"filter":"ASN == 1","from":"cookie1","to":"cookie2","cookie_name":"abc","rewrite_existing":true,"add_if_missing":false,"rule_name":"New delivery rule","action":"RULE_ACTION_REWRITE_COOKIE","enabled":true},{"filter":"ASN == 1","from":"header1","to":"header2","header_name":"abc","rewrite_existing":true,"add_if_missing":false,"rule_name":"New delivery rule","action":"RULE_ACTION_REWRITE_HEADER","enabled":true},{"filter":"ASN == 1","from":"/1","to":"/2","rule_name":"New delivery rule","action":"RULE_ACTION_REWRITE_URL","enabled":true},{"filter":"ASN == 1","header_name":"abc","multiple_headers_deletion":false,"rule_name":"New delivery rule","action":"RULE_ACTION_DELETE_HEADER","enabled":true},{"filter":"ASN == 1","cookie_name":"abc","rule_name":"New delivery rule","action":"RULE_ACTION_DELETE_COOKIE","enabled":true}]}
\n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_RESPONSE_REWRITE_HEADER (RewriteResponseHeaderRuleDTO),
RULE_ACTION_RESPONSE_DELETE_HEADER (RewriteResponseDeleteHeaderRuleDTO),
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE (RewriteResponseCodeRuleDTO),
RULE_ACTION_CUSTOM_ERROR_RESPONSE (RewriteResponseCustomErrorRuleDTO)
\n 
{"data":[{"filter":"ASN == 1","header_name":"abc","multiple_headers_deletion":false,"rule_name":"New delivery rule","action":"RULE_ACTION_RESPONSE_DELETE_HEADER","enabled":true},{"filter":"ASN == 1","from":"header1","to":"header2","header_name":"abc","rewrite_existing":true,"add_if_missing":false,"rule_name":"New delivery rule","action":"RULE_ACTION_RESPONSE_REWRITE_HEADER","enabled":true},{"filter":"ASN == 1","response_code":302,"rule_name":"New delivery rule","action":"RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE","enabled":true},{"filter":"ASN == 1","error_response_format":"[JSON|XML]","error_response_data":"<?xml version="1.0" encoding="UTF-8"?>","error_type":"error.type.all","response_code":400,"rule_name":"New delivery rule","action":"RULE_ACTION_CUSTOM_ERROR_RESPONSE","enabled":true}]}
\n

401

\n Unauthorized\n ApiErrorResponse\n

404

\n Not Found\n ApiErrorResponse\n

500

\n Server Error\n ApiErrorResponse\n
\n
\n \n 
post /api/prov/v1/sites/list
\n
List sites (listSites)
\n
List sites for an account
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.<br/>If the account has sub accounts, the operation returns results for the sites in the account and in all of its sub accounts.
page_size (optional)
\n \n
Query Parameter — The number of objects to return in the response. Default is 50. Maximum: 100
page_num (optional)
\n \n
Query Parameter — The page to return starting from 0. Default is 0
\n\n\n

Return type

\n
\n ApiResultListSites\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ],\n  "ApiResultSiteStatus" : [ {\n    "login_protect" : {\n      "urls" : [ "/userlist", "/userlist" ],\n      "allow_all_users" : true,\n      "authentication_methods" : [ "email", "email" ],\n      "send_lp_notifications" : true,\n      "enabled" : true,\n      "specific_users_list" : [ {\n        "name" : "John Doe",\n        "email" : "John@example.com",\n        "status" : "INVITATION_SENT"\n      }, {\n        "name" : "John Doe",\n        "email" : "John@example.com",\n        "status" : "INVITATION_SENT"\n      } ],\n      "url_patterns" : [ "CONTAINS", "CONTAINS" ]\n    },\n    "site_creation_date" : 1610396346000,\n    "original_dns" : [ null, null ],\n    "set_site_cookies_without_domain" : true,\n    "ssl" : {\n      "origin_server" : {\n        "detected" : "true",\n        "detectionStatus" : "ok"\n      }\n    },\n    "debug_info" : [ {\n      "key" : { }\n    }, {\n      "key" : { }\n    } ],\n    "statusEnum" : "pending-dns-changes",\n    "security" : {\n      "waf" : {\n        "rules" : [ {\n          "id" : "api.threats.bot_access_control",\n          "name" : "Bot Access Control",\n          "block_bad_bots" : true,\n          "challenge_suspected_bots" : true\n        }, {\n          "id" : "api.threats.sql_injection",\n          "name" : "SQL Injection",\n          "action" : "api.threats.action.block_request",\n          "action_text" : "Block Request"\n        }, {\n          "id" : "api.threats.cross_site_scripting",\n          "name" : "Cross Site Scripting (XSS)",\n          "exceptions" : [ {\n            "values" : [ {\n              "urls" : [ {\n                "value" : "/gsddg",\n                "pattern" : "EQUALS"\n              } ],\n              "id" : "api.rule_exception_type.url",\n              "name" : "URL"\n            } ],\n            "id" : 244711494\n          } ],\n          "action" : "api.threats.action.alert",\n          "action_text" : "Alert Only"\n        }, {\n          "id" : "api.threats.illegal_resource_access",\n          "name" : "Illegal Resource Access",\n          "action" : "api.threats.action.block_user",\n          "action_text" : "Block User"\n        }, {\n          "id" : "api.threats.ddos",\n          "name" : "DDoS",\n          "activation_mode" : "api.threats.ddos.activation_mode.off",\n          "activation_mode_text" : "Off",\n          "ddos_traffic_threshold" : "api.threats.ddos.ddos_trassic_threshold",\n          "ddos_traffic_threshold_text" : "750",\n          "ddos_adaptive_threshold" : "500",\n          "ddos_adaptive_threshold_last_update_time" : "1610396346000"\n        }, {\n          "id" : "api.threats.backdoor",\n          "name" : "Backdoor Protect",\n          "action" : "api.threats.action.quarantine_url",\n          "action_text" : "Auto-Quarantine"\n        }, {\n          "action" : "api.threats.action.block_ip",\n          "action_text" : "Block IP",\n          "id" : "api.threats.remote_file_inclusion",\n          "name" : "Remote File Inclusion"\n        } ]\n      },\n      "acls" : {\n        "rules" : [ {\n          "ips" : [ "2.3.4.5" ],\n          "exceptions" : [ {\n            "values" : [ {\n              "id" : "api.rule_exception_type.url",\n              "name" : "URL",\n              "urls" : [ {\n                "value" : "/home",\n                "pattern" : "EQUALS"\n              } ]\n            } ],\n            "id" : 493271006\n          } ],\n          "id" : "api.acl.blacklisted_ips",\n          "name" : "Visitors from denylisted IPs"\n        } ]\n      }\n    },\n    "acceleration_level" : "advanced",\n    "requestBodyTimeouts" : {\n      "methods" : [ { }, { } ],\n      "byteCount" : 1,\n      "interval" : 6\n    },\n    "res" : 0,\n    "res_message" : "OK",\n    "support_all_tls_versions" : true,\n    "use_wildcard_san_instead_of_full_domain_san" : true,\n    "additionalErrors" : [ 3005, 3005 ],\n    "warnings" : [ {\n      "type" : "CNAME",\n      "set_data_to" : [ "67eufzur3g.dev.impervadns.net", "67eufzur3g.dev.impervadns.net" ]\n    }, {\n      "type" : "CNAME",\n      "set_data_to" : [ "67eufzur3g.dev.impervadns.net", "67eufzur3g.dev.impervadns.net" ]\n    } ],\n    "dns" : [ {\n      "dns_record_name" : "loginprotectapi1610396334653.incaptest.info",\n      "set_type_to" : "CNAME",\n      "set_data_to" : [ "67eufzur3g.dev.impervadns.net", "67eufzur3g.dev.impervadns.net" ]\n    }, {\n      "dns_record_name" : "loginprotectapi1610396334653.incaptest.info",\n      "set_type_to" : "CNAME",\n      "set_data_to" : [ "67eufzur3g.dev.impervadns.net", "67eufzur3g.dev.impervadns.net" ]\n    } ],\n    "active" : "active",\n    "restricted_cname_reuse" : true,\n    "performance_configuration" : {\n      "compress_png" : true,\n      "aggressive_compression" : true,\n      "use_shortest_caching" : true,\n      "perfer_last_modified" : true,\n      "minify_css" : true,\n      "comply_no_cache" : true,\n      "comply_vary" : true,\n      "advanced_caching_rules" : {\n        "never_cache_resources" : [ {\n          "pattern" : "SUFFIX",\n          "url" : "/test.html"\n        } ],\n        "always_cache_resources" : [ {\n          "pattern" : "NOT_EQUALS",\n          "url" : "/index.html",\n          "ttl" : "5",\n          "ttlUnits" : "SECONDS"\n        }, {\n          "pattern" : "EQUALS",\n          "url" : "/home.html",\n          "ttl" : "6",\n          "ttlUnits" : "DAYS"\n        } ]\n      },\n      "prefer_last_modified" : true,\n      "cache_headers" : [ { }, { } ],\n      "acceleration_level_raw" : "none",\n      "async_validation" : true,\n      "progressive_image_rendering" : true,\n      "compress_jepg" : true,\n      "disable_client_side_caching" : true,\n      "minify_javascript" : true,\n      "minify_static_html" : true,\n      "cache300x" : true,\n      "acceleration_level" : "advanced",\n      "on_the_fly_compression" : true,\n      "tcp_pre_pooling" : true,\n      "compress_jpeg" : true\n    },\n    "display_name" : "loginprotectapi1610396334653.incaptest.info",\n    "ips" : [ "1.2.3.4", "1.2.3.4" ],\n    "acceleration_level_raw" : "none",\n    "account_id" : 1,\n    "add_naked_domain_san" : true,\n    "domain" : "admin@example.com",\n    "siteDualFactorSettings" : {\n      "customAreas" : [ {\n        "pattern" : "CONTAINS",\n        "url" : "/userlist"\n      }, {\n        "pattern" : "CONTAINS",\n        "url" : "/userlist"\n      } ],\n      "customAreasExceptions" : [ {\n        "pattern" : "CONTAINS",\n        "url" : "/userlist"\n      }, {\n        "pattern" : "CONTAINS",\n        "url" : "/userlist"\n      } ],\n      "application" : true,\n      "shouldSendLoginNotifications" : true,\n      "specificUsers" : [ "lpuser1_api1610396342408@incaptest.info", "lpuser1_api1610396342408@incaptest.info" ],\n      "allowAllUsers" : true,\n      "shouldSuggestApplicatons" : true,\n      "allowedMedia" : [ "sms", "sms" ],\n      "version" : 0,\n      "enabled" : false\n    },\n    "site_id" : 10,\n    "extended_ddos" : 5,\n    "incap_rules" : [ {\n      "updated_at" : 1611228121241,\n      "name" : "Block Click Worms",\n      "updated_by" : "John",\n      "action" : "api.rule_action_type.rule_action_block",\n      "rule" : "ClientIP == 1.2.3.4",\n      "comment" : "rule comment",\n      "id" : 123,\n      "creation_date" : 5\n    }, {\n      "updated_at" : 1611228121241,\n      "name" : "Block Click Worms",\n      "updated_by" : "John",\n      "action" : "api.rule_action_type.rule_action_block",\n      "rule" : "ClientIP == 1.2.3.4",\n      "comment" : "rule comment",\n      "id" : 123,\n      "creation_date" : 5\n    } ],\n    "status" : "pending-dns-changes",\n    "enable_http_between_Imperva_and_origin" : "80"\n  }, {\n    "login_protect" : {\n      "urls" : [ "/userlist", "/userlist" ],\n      "allow_all_users" : true,\n      "authentication_methods" : [ "email", "email" ],\n      "send_lp_notifications" : true,\n      "enabled" : true,\n      "specific_users_list" : [ {\n        "name" : "John Doe",\n        "email" : "John@example.com",\n        "status" : "INVITATION_SENT"\n      }, {\n        "name" : "John Doe",\n        "email" : "John@example.com",\n        "status" : "INVITATION_SENT"\n      } ],\n      "url_patterns" : [ "CONTAINS", "CONTAINS" ]\n    },\n    "site_creation_date" : 1610396346000,\n    "original_dns" : [ null, null ],\n    "set_site_cookies_without_domain" : true,\n    "ssl" : {\n      "origin_server" : {\n        "detected" : "true",\n        "detectionStatus" : "ok"\n      }\n    },\n    "debug_info" : [ {\n      "key" : { }\n    }, {\n      "key" : { }\n    } ],\n    "statusEnum" : "pending-dns-changes",\n    "security" : {\n      "waf" : {\n        "rules" : [ {\n          "id" : "api.threats.bot_access_control",\n          "name" : "Bot Access Control",\n          "block_bad_bots" : true,\n          "challenge_suspected_bots" : true\n        }, {\n          "id" : "api.threats.sql_injection",\n          "name" : "SQL Injection",\n          "action" : "api.threats.action.block_request",\n          "action_text" : "Block Request"\n        }, {\n          "id" : "api.threats.cross_site_scripting",\n          "name" : "Cross Site Scripting (XSS)",\n          "exceptions" : [ {\n            "values" : [ {\n              "urls" : [ {\n                "value" : "/gsddg",\n                "pattern" : "EQUALS"\n              } ],\n              "id" : "api.rule_exception_type.url",\n              "name" : "URL"\n            } ],\n            "id" : 244711494\n          } ],\n          "action" : "api.threats.action.alert",\n          "action_text" : "Alert Only"\n        }, {\n          "id" : "api.threats.illegal_resource_access",\n          "name" : "Illegal Resource Access",\n          "action" : "api.threats.action.block_user",\n          "action_text" : "Block User"\n        }, {\n          "id" : "api.threats.ddos",\n          "name" : "DDoS",\n          "activation_mode" : "api.threats.ddos.activation_mode.off",\n          "activation_mode_text" : "Off",\n          "ddos_traffic_threshold" : "api.threats.ddos.ddos_trassic_threshold",\n          "ddos_traffic_threshold_text" : "750",\n          "ddos_adaptive_threshold" : "500",\n          "ddos_adaptive_threshold_last_update_time" : "1610396346000"\n        }, {\n          "id" : "api.threats.backdoor",\n          "name" : "Backdoor Protect",\n          "action" : "api.threats.action.quarantine_url",\n          "action_text" : "Auto-Quarantine"\n        }, {\n          "action" : "api.threats.action.block_ip",\n          "action_text" : "Block IP",\n          "id" : "api.threats.remote_file_inclusion",\n          "name" : "Remote File Inclusion"\n        } ]\n      },\n      "acls" : {\n        "rules" : [ {\n          "ips" : [ "2.3.4.5" ],\n          "exceptions" : [ {\n            "values" : [ {\n              "id" : "api.rule_exception_type.url",\n              "name" : "URL",\n              "urls" : [ {\n                "value" : "/home",\n                "pattern" : "EQUALS"\n              } ]\n            } ],\n            "id" : 493271006\n          } ],\n          "id" : "api.acl.blacklisted_ips",\n          "name" : "Visitors from denylisted IPs"\n        } ]\n      }\n    },\n    "acceleration_level" : "advanced",\n    "requestBodyTimeouts" : {\n      "methods" : [ { }, { } ],\n      "byteCount" : 1,\n      "interval" : 6\n    },\n    "res" : 0,\n    "res_message" : "OK",\n    "support_all_tls_versions" : true,\n    "use_wildcard_san_instead_of_full_domain_san" : true,\n    "additionalErrors" : [ 3005, 3005 ],\n    "warnings" : [ {\n      "type" : "CNAME",\n      "set_data_to" : [ "67eufzur3g.dev.impervadns.net", "67eufzur3g.dev.impervadns.net" ]\n    }, {\n      "type" : "CNAME",\n      "set_data_to" : [ "67eufzur3g.dev.impervadns.net", "67eufzur3g.dev.impervadns.net" ]\n    } ],\n    "dns" : [ {\n      "dns_record_name" : "loginprotectapi1610396334653.incaptest.info",\n      "set_type_to" : "CNAME",\n      "set_data_to" : [ "67eufzur3g.dev.impervadns.net", "67eufzur3g.dev.impervadns.net" ]\n    }, {\n      "dns_record_name" : "loginprotectapi1610396334653.incaptest.info",\n      "set_type_to" : "CNAME",\n      "set_data_to" : [ "67eufzur3g.dev.impervadns.net", "67eufzur3g.dev.impervadns.net" ]\n    } ],\n    "active" : "active",\n    "restricted_cname_reuse" : true,\n    "performance_configuration" : {\n      "compress_png" : true,\n      "aggressive_compression" : true,\n      "use_shortest_caching" : true,\n      "perfer_last_modified" : true,\n      "minify_css" : true,\n      "comply_no_cache" : true,\n      "comply_vary" : true,\n      "advanced_caching_rules" : {\n        "never_cache_resources" : [ {\n          "pattern" : "SUFFIX",\n          "url" : "/test.html"\n        } ],\n        "always_cache_resources" : [ {\n          "pattern" : "NOT_EQUALS",\n          "url" : "/index.html",\n          "ttl" : "5",\n          "ttlUnits" : "SECONDS"\n        }, {\n          "pattern" : "EQUALS",\n          "url" : "/home.html",\n          "ttl" : "6",\n          "ttlUnits" : "DAYS"\n        } ]\n      },\n      "prefer_last_modified" : true,\n      "cache_headers" : [ { }, { } ],\n      "acceleration_level_raw" : "none",\n      "async_validation" : true,\n      "progressive_image_rendering" : true,\n      "compress_jepg" : true,\n      "disable_client_side_caching" : true,\n      "minify_javascript" : true,\n      "minify_static_html" : true,\n      "cache300x" : true,\n      "acceleration_level" : "advanced",\n      "on_the_fly_compression" : true,\n      "tcp_pre_pooling" : true,\n      "compress_jpeg" : true\n    },\n    "display_name" : "loginprotectapi1610396334653.incaptest.info",\n    "ips" : [ "1.2.3.4", "1.2.3.4" ],\n    "acceleration_level_raw" : "none",\n    "account_id" : 1,\n    "add_naked_domain_san" : true,\n    "domain" : "admin@example.com",\n    "siteDualFactorSettings" : {\n      "customAreas" : [ {\n        "pattern" : "CONTAINS",\n        "url" : "/userlist"\n      }, {\n        "pattern" : "CONTAINS",\n        "url" : "/userlist"\n      } ],\n      "customAreasExceptions" : [ {\n        "pattern" : "CONTAINS",\n        "url" : "/userlist"\n      }, {\n        "pattern" : "CONTAINS",\n        "url" : "/userlist"\n      } ],\n      "application" : true,\n      "shouldSendLoginNotifications" : true,\n      "specificUsers" : [ "lpuser1_api1610396342408@incaptest.info", "lpuser1_api1610396342408@incaptest.info" ],\n      "allowAllUsers" : true,\n      "shouldSuggestApplicatons" : true,\n      "allowedMedia" : [ "sms", "sms" ],\n      "version" : 0,\n      "enabled" : false\n    },\n    "site_id" : 10,\n    "extended_ddos" : 5,\n    "incap_rules" : [ {\n      "updated_at" : 1611228121241,\n      "name" : "Block Click Worms",\n      "updated_by" : "John",\n      "action" : "api.rule_action_type.rule_action_block",\n      "rule" : "ClientIP == 1.2.3.4",\n      "comment" : "rule comment",\n      "id" : 123,\n      "creation_date" : 5\n    }, {\n      "updated_at" : 1611228121241,\n      "name" : "Block Click Worms",\n      "updated_by" : "John",\n      "action" : "api.rule_action_type.rule_action_block",\n      "rule" : "ClientIP == 1.2.3.4",\n      "comment" : "rule comment",\n      "id" : 123,\n      "creation_date" : 5\n    } ],\n    "status" : "pending-dns-changes",\n    "enable_http_between_Imperva_and_origin" : "80"\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>1 - Unexpected error\n ApiResultListSites\n
\n
\n \n 
post /api/prov/v1/sites/performance/advanced
\n
Advanced caching settings (modifyAdvancedCachingSettings)
\n
Use this operation to modify advanced caching settings.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
param (required)
\n \n
Query Parameter — Name of configuration parameter to set.<br/>Possible values for param and value parameters:<br/><ul><li><b>async_validation</b> Sets Async validation. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>minify_javascript</b> Sets the Minify JS. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>minify_css</b> Sets the Minify CSS. Pass &quot;true&quot; or &quot;false&quot; in the value parameter</li><li><b>minify_static_html</b> Sets Minify static HTML. Pass &quot;true&quot; or &quot;false&quot; in the value parameter</li><li><b>compress_jpeg</b> Sets the Compress JPEG. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>progressive_image_rendering</b> Sets the Progressive Image rendering flag. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>aggressive_compression</b> Sets the Aggressive compression rendering flag. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>compress_png</b> Sets the Compress PNG flag. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>on_the_fly_compression</b> &quot;On the fly&quot; Compression. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>tcp_pre_pooling</b> TCP Pre-Pooling. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>comply_no_cache</b> Comply with no-cache and max-age directives in client requests. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>comply_vary</b> Comply with the <b>Vary</b> header. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>use_shortest_caching</b> Use shortest caching duration in case of conflicts. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>prefer_last_modified</b> Prefer 'last modified' over eTag. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>disable_client_side_caching</b> Disable client side caching. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>cache_300x</b> Cache 300X responses. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>unite_naked_full_cache</b> Use the same cache for full and naked domains. For example, use the same cached resource for <a href="https://www.example.com/a"></a> and <a href="https://example.com/"></a>a.</li><li><b>cache_empty_responses</b> Cache responses that don’t have a message body.</li><li><b>cache_http_10_responses</b> Cache HTTP 1.0 type responses that don’t include the Content-Length header or chunking. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>send_age_header</b> Send <b>Cache-Control: max-age</b> and <b>Age</b> headers. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>support_non_sni_clients</b> Enable or disable the support for Non-SNI clients for TLS connections between clients and Imperva. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>origin_connection_reuse</b> Requests from multiple client connections may be transmitted through a single TCP connection to the origin, while requests from a single client connection may be distributed across multiple TCP connections to the origin. This option disables that behavior.. Pass &quot;true&quot; or &quot;false&quot; in the value parameter.</li><li><b>redirect_http_to_https</b> Redirect HTTP requests to HTTPS requests by sending an HTTP 301 response.</li><li><b>redirect_naked_domain_to_full</b> Redirect requests from your website's naked domain to its full domain by sending and HTTP 301 response.</li><li><b>http_2</b> Enables supporting browsers to take advantage of the performance enhancements provided by HTTP/2 for your website. Non-supporting browsers can connect via HTTP/1.0 or HTTP/1.1. HTTP/2 support requires that SSL is configured for your website. Pass &quot;true&quot; or &quot;false&quot; in the value parameter</li></ul>
value (required)
\n \n
Query Parameter — According to the param value.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>5 - Operation unavailable\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/performance/cache404/modify
\n
Modify cache 404 settings (modifyCache404Settings)
\n
Use this operation to modify the caching settings of 404 responses for a site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
enable (required)
\n \n
Query Parameter — Pass 'true' to cache 404 responses, 'false' to disable the option.
time (optional)
\n \n
Query Parameter — A positive number representing the amount of time to cache 404 responses. Default value: 10
time_unit (optional)
\n \n
Query Parameter — Unit of time for caching 404 responses. One of MINUTES, HOURS, DAYS, WEEKS. Default value: HOURS
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/performance/purge
\n
Purge resources (modifyPurgeSettings)
\n
Use this operation to purge site resources.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
resource_url (required)
\n \n
Query Parameter — Comma separated list of URLs where the resource is located.
resource_pattern (required)
\n \n
Query Parameter — Comma separated list of pattern. One of: contains | equals | prefix | suffix | not_equals | not_contains | not_prefix | not_suffix
should_purge_all_site_resources (optional)
\n \n
Query Parameter — Should purge all cached resources on site.</br>Possible values:</br>If the parameter does not exist, is null, or an empty string, it is ignored and only specific resources defined by the resource_pattern and resource_url parameters are purged.</br><b>true</b> or <b>TRUE</b>: All site resources are purged.</br><b>false</b> or <b>FALSE</b>: Nothing is done.</br>Any other string: An error is returned.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>3015 - Internal error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/performance/response-headers
\n
Modify cached response headers (modifyResponseHeaderSettings)
\n
Use this operation to modify cached response headers.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
cache_headers (optional)
\n \n
Query Parameter — Comma separated list of header names to be cached
cache_all_headers (optional)
\n \n
Query Parameter — Cache all response headers. Pass &quot;true&quot; or &quot;false&quot; in the value parameter. Cannot be selected together with cache_headers. Default:false
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/performance/rewrite-port/modify
\n
Modify rewrite port (modifyRewritePorts)
\n
Use this operation to rewrite the port number used to access the origin server.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
rewrite_port_enabled (required)
\n \n
Query Parameter — Boolean value to indicate whether the default non-SSL port should be rewritten or not
port (optional)
\n \n
Query Parameter — The port number. If empty, rewrite port will be removed
rewrite_ssl_port_enabled (required)
\n \n
Query Parameter — Boolean value to indicate whether the default SSL port should be rewritten or not
ssl_port (optional)
\n \n
Query Parameter — The port number to rewrite default SSL port to
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/configure
\n
Modify site configuration (modifySiteConfiguration)
\n
Use this operation to change one of the basic configuration settings of the site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
param (required)
\n \n
Query Parameter — Name of configuration parameter to set.<br/>Parameter values:<br/><ul><li><b>active</b> Whether the site is active or bypassed by the Imperva network. One of: active | bypass.</li><li><b>site_ip</b> Comma separated list of IPs. For example: 8.8.8.8,1.2.2.2</li><li><b>domain_validation</b> Sets the domain validation method that will be used to generate an SSL certificate. One of: email | html | dns | cname<br/><b>One-step onboarding:</b> After adding a site and configuring your traffic to point to Imperva, use the html option to automatically add SSL support. Certificate creation takes approximately 5 minutes. During this time no traffic will reach the origin server.<br/><b>Note</b>: When running domain validation on a site, you may see the following error message in the API response: Internal error - &quot;Add site operation hasn't finished&quot;.<br/>After running the add site process, it may take several minutes for the database to finish updating. During this time, attempts to further configure the site are blocked.<br/>In some cases, the database is not updated even after the add site process is complete.<br/>If the issue does not resolve after a few minutes, contact Support.</li><li><b>approver</b> Sets the approver e-mail address that will be used to perform SSL domain validation.</li><li><b>ignore_ssl</b> Sets the ignore SSL flag (if the site is in pending-select-approver state). Pass &quot;true&quot; in the value parameter.</li><li><b>acceleration_level</b> Sets the acceleration level of the site, one of: none | standard | aggressive. It is advised to use the newer Modify caching mode API call instead, as it provides enhanced functionality.</li><li><b>seal_location</b> Sets the seal location, e.g. &quot;api.seal_location.bottom_right&quot;.</li><li><b>domain_redirect_to_full</b> Sets the redirect naked to full flag. Pass &quot;true&quot; in the value parameter.</li><li><b>remove_ssl</b> Sets the remove SSL from site flag. Pass &quot;true&quot; in the value parameter.</li><li><b>ref_id</b> Sets the Reference ID, a free-text field that enables you to add a unique identifier to correlate an object in our service, such as a protected website, with an object on the customer side.</li><li><b>naked_domain_san</b> Use this option to determine if the naked domain SAN will be added to the SSL certificate for www site. Will take effect in the next renewal.</li><li><b>wildcard_san</b> Use this option to determine if the wildcard SAN or the full domain SAN is added to the Imperva SSL certificate for site. Will take effect in the next renewal.</li><li><b>set_cookies_without_domain</b> Use this option to determine if to set site cookies without domain.</li><li><b>restricted_cname_reuse</b> Use this option to determine if legitimate traffic for all verified domains in the table is automatically allowed.</li><li><b>request_body_timeouts</b> Use this option to override default mitigation settings for slow HTTP attacks.</li><b>Note</b>: Send value in the format of {“methods”: [method name,method name,…],“interval”: integer,“byteCount”: integer}. For example: {“methods”: [HTTP_POST, HTTP_GET],“interval”:30,“byteCount”:20}. Each post of the API overwrites the custom configuration. To delete the whole custom configuration, send {} as the value. Possible values for method: HTTP_POST, HTTP_GET, HTTP_PUT, HTTP_RPC_IN_DATA, HTTP_RPC_OUT_DATA</ul>
value (required)
\n \n
Query Parameter — According to the param value.
\n\n\n

Return type

\n
\n inline_response_200_14\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3015 - Internal error<br/>6001 - Invalid configuration parameter name<br/>6002 - Invalid configuration parameter value<br/>1 - Unexpected error<br/>9414 - Feature not permitted\n inline_response_200_14\n
\n
\n \n 
post /api/prov/v1/sites/performance/error-page/modify
\n
Modify error page (modifySiteErrorPageTemplate)
\n
Use this operation to set a custom error page for a given site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
error_page_template (required)
\n \n
Query Parameter — The error page html template. $TITLE$ and $BODY$ placeholders are required.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/setlog
\n
Modify site logs level (modifySiteLogLevel)
\n
Use this operation to change the site log configuration.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
log_level (required)
\n \n
Query Parameter — Available only for customers that purchased the Logs Integration SKU. Sets the log reporting level for the site.<br/>Possible values: full, security, none, default
logs_account_id (optional)
\n \n
Query Parameter — Available only for customers that purchased the Logs Integration SKU. Numeric identifier of the account that purchased the logs integration SKU and which collects the logs.<br/>If not specified, operation will be performed on the account identified by the authentication parameters
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>6002 - Invalid configuration parameter name<br/>6001 - Invalid configuration parameter name<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/configure/security
\n
Modify site security configuration (modifySiteSecurityConfiguration)
\n
Use this operation to change the security configuration of a site. To modify the configuration for a specific rule, additional parameters may be required, as documented below.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
rule_id (required)
\n \n
Query Parameter — ID of the security rule to change.<br/>Values for the rule_id parameter:<br/><ul><li>api.threats.bot_access_control</li><li>api.threats.sql_injection</li><li>api.threats.cross_site_scripting</li><li>api.threats.backdoor</li><li>api.threats.ddos</li><li>api.threats.remote_file_inclusion</li></ul>
block_bad_bots (optional)
\n \n
Query Parameter — Whether or not to block bad bots. Possible values: true, false
challenge_suspected_bots (optional)
\n \n
Query Parameter — Whether or not to send a challenge to clients that are suspected to be bad bots (CAPTCHA for example). Possible values: true, false
activation_mode (optional)
\n \n
Query Parameter — Possible values: api.threats.ddos.activation_mode.off, api.threats.ddos.activation_mode.auto, api.threats.ddos.activation_mode.on, api.threats.ddos.activation_mode.adaptive<br/><ul><li><b>api.threats.ddos.activation_mode.off</b> Security measures are disabled even if site is under a DDoS attack</li><li><b>api.threats.ddos.activation_mode.auto</b> Security measures will be activated automatically when the system suspects site is under a DDoS attack</li><li><b>api.threats.ddos.activation_mode.on</b> Security measures are enabled even if site is not under a DDoS attack</li><li><b>api.threats.ddos.activation_mode.adaptive</b> Security measures are enabled with an adaptive threshold based on the website's traffic</li></ul>The syntax is as follows:&lt;rule_id&gt;.activation_mode.<value> For example, for 'off', use 'activation_mode=api.threats.ddos.activation_mode.off.<br/><b>Note:</b> This parameter is relevant and required for a DDoS rule only -- where rule_id=api.threats.ddos.
security_rule_action (optional)
\n \n
Query Parameter — The action that should be taken when a threat is detected, for example:<br/>api.threats.action.block_ip. Different actions are allowed per different threats, e.g. backdoors may only be quarantined, ignored, or trigger an alert.<br/>Values for the security_rule_action parameter:<br/><ul><li><b>api.threats.action.disabled</b> Threat is not blocked, site owner is not notified.</li><li><b>api.threats.action.alert</b> Threat is not blocked, site owner is notified.</li><li><b>api.threats.action.block_request</b> Threat blocked by stopping the request, site owner is notified.</li><li><b>api.threats.action.block_user</b> Threat blocked by stopping the request. Additional requests by the client application will be automatically blocked for a duration of several minutes. Site owner is notified.</li><li><b>api.threats.action.block_ip</b> Threat blocked by stopping the request. Additional requests from the same IP addresses will be automatically blocked for a duration of several minutes. Site owner is notified.</li><li><b>api.threats.action.quarantine_url</b> Relevant only for Backdoor Protect. When detecting a backdoor, additional requests to the URL of the backdoor will be automatically blocked. Site owner is notified.</li></ul>
quarantined_urls (optional)
\n \n
Query Parameter — Removes quarantined URLs from the backdoor protection list, as defined in the Cloud Security Console Website Settings &gt; WAF Settings &gt; Backdoor Protect.<br/>To remove a URL from the backdoor protection list, use the following parameters with the specified values:<br/>quarantined_urls: <URL full path><br/>rule_id: api.threats.backdoor<br/>security_rule_action: api.threats.action.quarantine_url
ddos_traffic_threshold (optional)
\n \n
Query Parameter — Consider site to be under DDoS if the request rate is above this threshold.<br/><b>Allowed values:</b> 10-10000 requests per second. format: int64
unknown_clients_challenge (optional)
\n \n
Query Parameter — Defines a method used for challenging suspicious bots. Possible values: none, cookies, javascript, captcha. This parameter is relevant for a DDoS rule only.
block_non_essential_bots (optional)
\n \n
Query Parameter — If non-essential bots should be blocked or not. Possible values: true, false. This parameter is relevant for a DDoS rule only.
\n\n\n

Return type

\n
\n inline_response_200_14\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9414 - Feature not permitted<br/>9415 - Operation not allowed<br/>2 - Invalid input\n inline_response_200_14\n
\n
\n \n 
post /api/prov/v1/sites/tls
\n
Set support for all TLS versions (modifySiteSupportDeprecatedTLS)
\n
Use this operation to support all TLS versions for the site for connectivity between clients (visitors) and the Imperva service. To remain PCI-compliant, do not enable this option.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
support_all_tls_versions (required)
\n \n
Query Parameter — Support all TLS versions. Default value: false
\n\n\n

Return type

\n
\n inline_response_200_34\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>5 - Operation unavailable<br/>9415 - Operation not allowed<br/>1 - Unexpected error\n inline_response_200_34\n
\n
\n \n 
post /api/prov/v1/sites/performance/stale-content
\n
Modify stale content settings (modifyStaleContent)
\n
When Imperva can't connect to the origin server, serve stale content instead of displaying an error to end users for the specified amount of time. Expired resources are returned from cache, and refreshed asynchronously in the background.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
serve_stale_content (required)
\n \n
Query Parameter — Pass <b>true</b> to serve stale content, <b>false</b> to disable the option.
stale_content_mode (required)
\n \n
Query Parameter — Pass <b>ADAPTIVE</b> to use Imperva's algorithm, or <b>CUSTOM</b> to specify an amount of time. When using <b>CUSTOM</b>, you must specify the time and time_unit parameters.
time (optional)
\n \n
Query Parameter — A positive number representing the amount of time to serve stale content.
time_unit (optional)
\n \n
Query Parameter — Stale content time unit. One of SECONDS, MINUTES, HOURS.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed<br/>5 - Operation unavailable\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/performance/tag-response
\n
Tag the response according to the value of a header (modifyTagResponseHeader)
\n
Specify which origin response header contains the cache tags in your resources.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
header (required)
\n \n
Query Parameter — Specify which origin response header contains the cache tags in your resources. default: &quot;&quot;.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/moveSite
\n
Move site (moveSite)
\n
Use this operation to move a site from its account to another account.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to move format: int64
destination_account_id (required)
\n \n
Query Parameter — The numeric identifier of the account which the site will be moved to format: int64
\n\n\n

Return type

\n
\n inline_response_200_35\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9415 - Operation not allowed\n inline_response_200_35\n
\n
\n \n 
post /api/prov/v1/sites/hostname/purge
\n
Purge hostname from cache (purgeHostname)
\n
Use this operation to purge the hostname from the cache. This API is for customers who use the same CNAME provided by Imperva for multiple hostnames and would like to change the CNAME for a particular hostname. Purging the hostname is required for the CNAME change to take effect.
\n\n\n\n\n\n

Query parameters

\n
\n
host_name (optional)
\n \n
Query Parameter — The hostname to purge from the cache
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>3015 - Internal error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/cache/purge
\n
Purge site cache (purgeSiteCache)
\n
Use this operation to purge all cached content on our proxy servers for a specific site.
Our Proxy servers keep cached content of your sites in order to accelerate page load times for your users.
When you want this cached content to be refreshed (for example, after making adjustments in your site) you can use this API call.
In order to purge the entire cached content for this site just use the API call with no parameters.
If you want to purge a specific resource add the resource name as parameter.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
purge_pattern (optional)
\n \n
Query Parameter — The pattern of the resource to be purged from the cache. For example:</br><ul/><li><b>Resource_name</b> - Resources that contain Resource_name will be purged</li><li><b>^Resource_name</b> - Resources that start with Resource_name will be purged</li><li><b>Resource_name$</b> - Resources that end with Resource_name will be purged.</li></ul>
purge_tag_names (optional)
\n \n
Query Parameter — A comma separated list of tag names to purge.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>5010 - Pattern invalid<br/>9413 - Unknown/unauthorized site_id.<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
put /api/prov/v3/sites/{extSiteId}/data-centers-configuration
\n
set site's data centers' configuration (putDataCentersConfiguration)
\n
Use this operation to configure site's data centers and all their servers
\n\n

Path parameters

\n
\n
extSiteId (required)
\n \n
Path Parameter — format: int64
\n\n

Consumes

\n This API call consumes the following media types via the Content-Type request header:\n
    \n
  • application/json
    • \n
\n\n

Request body

\n
\n
body DataCentersConfigurationDTO (required)
\n \n
Body Parameter — JSON body. Schema is identical to the response.
\n
\n\n\n\n\n

Return type

\n
\n DataCentersConfigurationDTO\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "data" : [ {\n    "lbAlgorithm" : "GEO_PREFERRED",\n    "dataCenterMode" : "MULTIPLE_DC",\n    "kickStartPass" : "kickstart-pass",\n    "kickStartURL" : "https://www.example.com:443/kickStart",\n    "isPersistent" : false,\n    "dataCenters" : [ {\n      "lbAlgorithm" : "WEIGHTED",\n      "isContent" : true,\n      "weight" : 40,\n      "isRestOfTheWorld" : true,\n      "isActive" : false,\n      "geoLocations" : [ "AFRICA", "AFRICA" ],\n      "ipMode" : "MULTIPLE_IP",\n      "servers" : [ {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      }, {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      } ],\n      "originPop" : "lax",\n      "isEnabled" : false,\n      "name" : "London DC",\n      "id" : 7543,\n      "webServersPerServer" : 5\n    }, {\n      "lbAlgorithm" : "WEIGHTED",\n      "isContent" : true,\n      "weight" : 40,\n      "isRestOfTheWorld" : true,\n      "isActive" : false,\n      "geoLocations" : [ "AFRICA", "AFRICA" ],\n      "ipMode" : "MULTIPLE_IP",\n      "servers" : [ {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      }, {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      } ],\n      "originPop" : "lax",\n      "isEnabled" : false,\n      "name" : "London DC",\n      "id" : 7543,\n      "webServersPerServer" : 5\n    } ],\n    "kickStartUser" : "kickstart-user",\n    "minAvailableServersForDataCenterUp" : 3,\n    "failOverRequiredMonitors" : "MANY"\n  }, {\n    "lbAlgorithm" : "GEO_PREFERRED",\n    "dataCenterMode" : "MULTIPLE_DC",\n    "kickStartPass" : "kickstart-pass",\n    "kickStartURL" : "https://www.example.com:443/kickStart",\n    "isPersistent" : false,\n    "dataCenters" : [ {\n      "lbAlgorithm" : "WEIGHTED",\n      "isContent" : true,\n      "weight" : 40,\n      "isRestOfTheWorld" : true,\n      "isActive" : false,\n      "geoLocations" : [ "AFRICA", "AFRICA" ],\n      "ipMode" : "MULTIPLE_IP",\n      "servers" : [ {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      }, {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      } ],\n      "originPop" : "lax",\n      "isEnabled" : false,\n      "name" : "London DC",\n      "id" : 7543,\n      "webServersPerServer" : 5\n    }, {\n      "lbAlgorithm" : "WEIGHTED",\n      "isContent" : true,\n      "weight" : 40,\n      "isRestOfTheWorld" : true,\n      "isActive" : false,\n      "geoLocations" : [ "AFRICA", "AFRICA" ],\n      "ipMode" : "MULTIPLE_IP",\n      "servers" : [ {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      }, {\n        "serverMode" : "ACTIVE",\n        "address" : "1.2.3.4",\n        "isEnabled" : false,\n        "weight" : 70,\n        "id" : 7543\n      } ],\n      "originPop" : "lax",\n      "isEnabled" : false,\n      "name" : "London DC",\n      "id" : 7543,\n      "webServersPerServer" : 5\n    } ],\n    "kickStartUser" : "kickstart-user",\n    "minAvailableServersForDataCenterUp" : 3,\n    "failOverRequiredMonitors" : "MANY"\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n OK\n DataCentersConfigurationDTO\n

401

\n Unauthorized. E.g. Wrong API key, locked user\n ApiErrorResponse\n

403

\n Forbidden. E.g. Missing abilities\n ApiErrorResponse\n

404

\n Not Found. E.g. Site doesn't exist or belongs to other tenant\n ApiErrorResponse\n

406

\n Bad client request. Actually, HTTP 400 is more appropriate here\n ApiErrorResponse\n

500

\n Server Error\n ApiErrorResponse\n
\n
\n \n 
put /api/prov/v3/sites/{extSiteId}/delivery-rules-configuration
\n
Set site's delivery rules and priorities for a specific rule category. (putDeliveryRulesConfiguration)
\n
Use this operation to set all delivery rules for a specific category. The rules are prioritized by order of appearance.
Notes:
  • This API replaces all rules within the specified category, so existing rules that are not specified in the request will be deleted.
  • When using this resource, the rule names within each category must be unique. When multiple rules have the same name, the update would fail with an error message specifying the index of the offending rules.
\n\n

Path parameters

\n
\n
extSiteId (required)
\n \n
Path Parameter — Numeric identifier of the site to operate on. format: int64
\n\n

Consumes

\n This API call consumes the following media types via the Content-Type request header:\n
    \n
  • application/json
    • \n
\n\n

Request body

\n
\n
body DeliveryRulesListDTO (required)
\n \n
Body Parameter — JSON body. Schema is identical to the response.
\n
example: {\n "summary" : "REDIRECT category",\n "description" : "Supported actions:<br/> <b>RULE_ACTION_REDIRECT</b> (RedirectRuleDTO)",\n "value" : {\n "data" : [ {\n "filter" : "ASN == 1",\n "from" : "/1",\n "to" : "/2",\n "response_code" : 302,\n "rule_name" : "New delivery rule",\n "action" : "RULE_ACTION_REDIRECT",\n "enabled" : true\n } ]\n }\n}
\n\n\n

Query parameters

\n
\n
category (required)
\n \n
Query Parameter — Rules category. Possible values:<br>\n<b>REDIRECT</b> - Redirect requests with 30X response.<br>\n<b>SIMPLIFIED_REDIRECT</b> - Redirect requests with 30X response. (static redirect, doesn't support condition)<br>\n<b>REWRITE</b> - Modify, add, and remove different request attributes such as URL, headers and cookies.<br>\n<b>REWRITE_RESPONSE</b> - Modify, add, and remove different response attributes such as headers, status code and error responses.<br>\n<b>FORWARD</b> - Forward the request to a specific data-center or port.
\n\n\n\n \n\n\n

Produces

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

Responses

\n

200

\n OK\n \n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_FORWARD_TO_PORT (ForwardToPortRuleDTO),
RULE_ACTION_FORWARD_TO_DC (ForwardToDcRuleDTO)
\n 
{"data":[{"filter":"ASN == 1","dc_id":1234,"rule_name":"New delivery rule","action":"RULE_ACTION_FORWARD_TO_DC","enabled":true},{"filter":"ASN == 1","port_forwarding_context":"[header/port]","port_forwarding_value":"1234","rule_name":"New delivery rule","action":"RULE_ACTION_FORWARD_TO_PORT","enabled":true}]}
\n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_REDIRECT (RedirectRuleDTO)
\n 
{"data":[{"filter":"ASN == 1","from":"/1","to":"/2","response_code":302,"rule_name":"New delivery rule","action":"RULE_ACTION_REDIRECT","enabled":true}]}
\n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_SIMPLIFIED_REDIRECT (SimplifiedRedirectRuleDTO)
\n 
{"data":[{"from":"/1","to":"/2","response_code":302,"rule_name":"New delivery rule","action":"RULE_ACTION_REDIRECT","enabled":true}]}
\n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_REWRITE_COOKIE (RewriteRequestCookieRuleDTO),
RULE_ACTION_REWRITE_HEADER (RewriteRequestHeaderRuleDTO),
RULE_ACTION_REWRITE_URL (RewriteRequestUrlRuleDTO),
RULE_ACTION_DELETE_HEADER (RewriteRequestDeleteHeaderRuleDTO),
RULE_ACTION_DELETE_COOKIE (RewriteRequestDeleteCookieRuleDTO)
\n 
{"data":[{"filter":"ASN == 1","from":"cookie1","to":"cookie2","cookie_name":"abc","rewrite_existing":true,"add_if_missing":false,"rule_name":"New delivery rule","action":"RULE_ACTION_REWRITE_COOKIE","enabled":true},{"filter":"ASN == 1","from":"header1","to":"header2","header_name":"abc","rewrite_existing":true,"add_if_missing":false,"rule_name":"New delivery rule","action":"RULE_ACTION_REWRITE_HEADER","enabled":true},{"filter":"ASN == 1","from":"/1","to":"/2","rule_name":"New delivery rule","action":"RULE_ACTION_REWRITE_URL","enabled":true},{"filter":"ASN == 1","header_name":"abc","multiple_headers_deletion":false,"rule_name":"New delivery rule","action":"RULE_ACTION_DELETE_HEADER","enabled":true},{"filter":"ASN == 1","cookie_name":"abc","rule_name":"New delivery rule","action":"RULE_ACTION_DELETE_COOKIE","enabled":true}]}
\n

Example data

\n
Content-Type: Supported actions:
RULE_ACTION_RESPONSE_REWRITE_HEADER (RewriteResponseHeaderRuleDTO),
RULE_ACTION_RESPONSE_DELETE_HEADER (RewriteResponseDeleteHeaderRuleDTO),
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE (RewriteResponseCodeRuleDTO),
RULE_ACTION_CUSTOM_ERROR_RESPONSE (RewriteResponseCustomErrorRuleDTO)
\n 
{"data":[{"filter":"ASN == 1","header_name":"abc","multiple_headers_deletion":false,"rule_name":"New delivery rule","action":"RULE_ACTION_RESPONSE_DELETE_HEADER","enabled":true},{"filter":"ASN == 1","from":"header1","to":"header2","header_name":"abc","rewrite_existing":true,"add_if_missing":false,"rule_name":"New delivery rule","action":"RULE_ACTION_RESPONSE_REWRITE_HEADER","enabled":true},{"filter":"ASN == 1","response_code":302,"rule_name":"New delivery rule","action":"RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE","enabled":true},{"filter":"ASN == 1","error_response_format":"[JSON|XML]","error_response_data":"<?xml version="1.0" encoding="UTF-8"?>","error_type":"error.type.all","response_code":400,"rule_name":"New delivery rule","action":"RULE_ACTION_CUSTOM_ERROR_RESPONSE","enabled":true}]}
\n

401

\n Unauthorized\n ApiErrorResponse\n

404

\n Not Found\n ApiErrorResponse\n

406

\n Not Acceptable\n ApiErrorResponse\n

500

\n Server Error\n ApiErrorResponse\n
\n
\n \n 
post /api/prov/v1/sites/customCertificate/remove
\n
Remove custom certificate (removeCustomCertificate)
\n
Use this operation to remove a custom certificate.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (optional)
\n \n
Query Parameter — Numeric identifier of the site to operate on format: int64
auth_type (optional)
\n \n
Query Parameter — The authentication type of the certificate (RSA or ECC). Optional. If not provided, then RSA will be assume
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>4205 - Site does not have SSL<br/>9414 - Feature not permitted<br/>9414 - Feature not permitted</br>3015 - Internal error\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/dataCenters/resume
\n
Resume traffic to your active data centers (resumeTrafficToActiveDCs)
\n
When at least one active data center is back up, you have to manually reroute your traffic back to the active data center.
Traffic does not revert automatically to your active data centers.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 -Unknown/unauthorized site_id\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/performance/cache-mode
\n
Modify caching mode (setCachingMode)
\n
Use this operation to edit basic site caching settings.
\n\n\n\n\n\n

Query parameters

\n
\n
cache_mode (required)
\n \n
Query Parameter — Possible values:<br/><ul/><li>disable</li><li>custom_cache_rules_only</li><li>static_only</li><li>static_and_dynamic</li><li>aggressive</li>Default value: static_only</ul>
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
dynamic_cache_duration (optional)
\n \n
Query Parameter — Profile dynamic pages and cache duration. Pass a number followed by '_' and one of: hr | min | sec | days | weeks.</br>Default: 5_min
aggressive_cache_duration (optional)
\n \n
Query Parameter — Cache resource duration. Pass a number followed by '_' and one of: hr | min | sec | days | weeks</br>Default: 1_hr
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/datacenter/origin-pop/modify
\n
Set data center origin PoP (setDataCenterOriginPoP)
\n
Set an origin PoP for a given data center.
\n\n\n\n\n\n

Query parameters

\n
\n
dc_id (required)
\n \n
Query Parameter — Numeric identifier of the data center to operate on. format: int64
origin_pop (optional)
\n \n
Query Parameter — The ID of the PoP that serves as an access point between Imperva and the customer’s origin server. For example: “lax”, for Los Angeles.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>405 - Api is disabled</br>2 - invalid data center<br/>5 - Cant set Origin PoP for data center\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/data-privacy/region-change
\n
Set site data storage region (setDataRegion)
\n
Use this operation to set the site data region.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on. format: int64
data_storage_region (required)
\n \n
Query Parameter — The data region to use.
\n\n\n

Return type

\n
\n inline_response_200_31\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9415 - Operation not allowed\n inline_response_200_31\n
\n
\n \n 
post /api/prov/v1/sites/configure/htmlInjections
\n
Add, replace or remove a HTML injection rule (setHtmlInjectionRule)
\n
Use this operation to add a new HTML injection rule, or to replace or remove an existing rule.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
url (required)
\n \n
Query Parameter — The URL where the content is injected
url_pattern (required)
\n \n
Query Parameter — The url pattern. One of: contains | not_contains | equals | not_equals | prefix | suffix | not_prefix | not_suffix
location (required)
\n \n
Query Parameter — The location of the injection inside the URL ('head' or 'body_end')
content (optional)
\n \n
Query Parameter — The injected HTML snippet, Base64-encoded
delete_content (optional)
\n \n
Query Parameter — Whether or not to delete existing HTML content.<br/>Possible values: true/false
\n\n\n

Return type

\n
\n inline_response_200_32\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input\n inline_response_200_32\n
\n
\n \n 
post /api/prov/v1/sites/data-privacy/override-by-geo
\n
Set site regions by origin geolocation (setOverrideSiteRegionsByGeo)
\n
Use this operation to set the data storage region for each new site based on the geolocation of the origin server.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
override_site_regions_by_geo (required)
\n \n
Query Parameter — A boolean parameter. If it is set to &quot;true&quot;, the data storage region for each new site will be based on the geolocation of the origin server.
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/incapRules/priority/set
\n
Set rule priority (setPriority)
\n
Use this operation to change delivery rule's priority.
\n\n\n\n\n\n

Query parameters

\n
\n
rule_id (required)
\n \n
Query Parameter — Rule ID format: int64
priority (required)
\n \n
Query Parameter — New priority for the selected rule format: int32
\n\n\n

Return type

\n
\n SetPriorityResponse\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : "0",\n  "status" : "ok"\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9413 - Unknown/unauthorized site_id<br/>2 - Invalid input\n SetPriorityResponse\n
\n
\n \n 
post /api/prov/v1/sites/performance/secure-resources
\n
Modify secure resources mode (setSecureResourcesMode)
\n
Use this operation to modify the Secure Resources mode for a site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
secured_resources_mode (required)
\n \n
Query Parameter — <b>do_not_cache</b> - Do not cache HTTPS resources<br/><b>defaults</b> - Use default HTTPS caching. Do not cache HTML pages<br/><b>defaults_with_html</b> - Use default HTTPS caching. Also cache HTML pages<br/><b>general</b> - Cache HTTPS according to general caching settings
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>9413 - Unknown/unauthorized site_id<br/>9415 - Operation not allowed\n ApiResult\n
\n
\n \n 
post /api/prov/v1/sites/status
\n
Get site status (siteStatus)
\n
Use this operation to get the status of a site.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on
tests (optional)
\n \n
Query Parameter — List of tests to run on site before returning its status.<br/>A comma separated list of one of: domain_validation, services, dns<br/>Values for the stats parameters:<br/><ul><li><b>domain_validation</b> Runs the domain validation test on the specified site. This test will check for HTML meta tag or DNS records, according to the selected domain validation method.</li><li><b>services</b> Runs the services test on the specified site. This test will check the availability of HTTP and HTTPS connections on the site.</li><li><b>dns</b> Runs the DNS test on the specified site. This test will check whether the site owner performed the DNS changes required in order to protect the site.</li></ul>
\n\n\n

Return type

\n
\n inline_response_200_14\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>3001 - Domain invalid<br/>6002 - Invalid configuration parameter value<br/>9415 - Operation not allowed\n inline_response_200_14\n
\n
\n \n 
post /api/prov/v3/sites/{extSiteId}/settings/TLSConfiguration
\n
Update website TLS configuration (updateTLSConfiguration)
\n
Update the TLS configuration for a given website.
\n\n

Path parameters

\n
\n
extSiteId (required)
\n \n
Path Parameter — The Imperva ID of the website to operate on. format: int64
\n\n

Consumes

\n This API call consumes the following media types via the Content-Type request header:\n
    \n
  • application/json
    • \n
\n\n

Request body

\n
\n
body TLSConfigurationDto (required)
\n \n
Body Parameter — JSON body. Schema is identical or semi identical to the response.
\n
\n\n\n\n\n

Return type

\n
\n TLSConfigurationDto\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "data" : [ {\n    "hstsConfiguration" : {\n      "maxAge" : 7543,\n      "isEnabled" : false,\n      "subDomainsIncluded" : false,\n      "preLoaded" : false\n    }\n  }, {\n    "hstsConfiguration" : {\n      "maxAge" : 7543,\n      "isEnabled" : false,\n      "subDomainsIncluded" : false,\n      "preLoaded" : false\n    }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n OK\n TLSConfigurationDto\n

401

\n Unauthorized\n ApiErrorResponse\n

404

\n Not Found\n ApiErrorResponse\n

406

\n Not Acceptable\n ApiErrorResponse\n

500

\n Server Error\n ApiErrorResponse\n
\n
\n \n 
post /api/prov/v1/sites/customCertificate/upload
\n
Upload custom certificate (uploadCustomCertificate)
\n
Use this operation to upload a custom certificate for your site. The following SSL certificate file formats are supported: PFX, PEM, CER.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (optional)
\n \n
Query Parameter — Numeric identifier of the site to operate on format: int64
certificate (required)
\n \n
Query Parameter — The certificate file in base64 format
private_key (optional)
\n \n
Query Parameter — The private key of the certificate in base64 format. Optional in case of PFX certificate file format
passphrase (optional)
\n \n
Query Parameter — The passphrase used to protect your SSL certificate
auth_type (optional)
\n \n
Query Parameter — The authentication type of the certificate (RSA or ECC). Optional. If not provided, then RSA will be assume
input_hash (optional)
\n \n
Query Parameter — optional parameter. usually a hash representation for the concatenation of all inputs
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>4205 - Site does not have SSL<br/>9414 - Feature not permitted<br/>9414 - Feature not permitted</br>3015 - Internal error\n ApiResult\n

TrafficStatisticsAndLogs

\n
\n \n 
post /api/logscollector/change/status
\n
Change logs collector configuration status (changeLogsCollectorsConfigStatus)
\n
Change the status of the Logs Collector configuration.
\n\n\n\n\n\n

Query parameters

\n
\n
config_id (required)
\n \n
Query Parameter — The Logs Collector configuration identifier.
logs_config_new_status (required)
\n \n
Query Parameter — The new configuration status of the Logs Collector.\nPossible values: ACTIVE, SUSPENDED
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>13008 - Invalid configuration ID\n ApiResult\n
\n
\n \n 
post /api/v1/infra/events
\n
Get infrastructure protection events (getInfraEvents)
\n
Use this operation to get Infrastructure Protection event information for an account
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters.
event_type (optional)
\n \n
Query Parameter — A comma separated list of specific event types. Any of: GRE_TUNNEL_UP, GRE_TUNNEL_DOWN, ORIGIN_CONNECTION_GRE_UP, ORIGIN_CONNECTION_GRE_DOWN, ORIGIN_CONNECTION_ECX_UP, ORIGIN_CONNECTION_ECX_DOWN, ORIGIN_CONNECTION_CROSS_CONNECT_UP, ORIGIN_CONNECTION_CROSS_CONNECT_DOWN, DDOS_START_IP_RANGE, DDOS_STOP_IP_RANGE, DDOS_QUIET_TIME_IP_RANGE, EXPORTER_NO_DATA, EXPORTER_BAD_DATA, EXPORTER_GOOD_DATA, MONITORING_CRITICAL_ATTACK, PROTECTED_IP_STATUS_UP, PROTECTED_IP_STATUS_DOWN, PER_IP_DDOS_START_IP_RANGE.
ip_prefix (optional)
\n \n
Query Parameter — Specific Protected IP or IP range. For example, 1.1.1.0/24.
page_size (optional)
\n \n
Query Parameter — The number of objects to return in the response.<br/>Default: 50<br/>Maximum: 100
page_num (optional)
\n \n
Query Parameter — The page to return starting from 0. Default: 0
start (optional)
\n \n
Query Parameter — The start date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul>
end (optional)
\n \n
Query Parameter — The end date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul>
\n\n\n

Return type

\n
\n inline_response_200_5\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input\n inline_response_200_5\n
\n
\n \n 
post /api/v1/infra/histogram
\n
Get infrastructure protection histogram (getInfraProtectHistogram)
\n
Use this operation to view the highest packet size values for a protected IP range during a selected time period.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters. format: int64
ip_range (required)
\n \n
Query Parameter — The customer's IP range.
range_type (required)
\n \n
Query Parameter — One of the following: BGP, PROTECTED_IP, NETFLOW
start (required)
\n \n
Query Parameter — The start date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul> format: int64
end (required)
\n \n
Query Parameter — The end date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul> format: int64
mitigation_type (required)
\n \n
Query Parameter — One of the following: BLOCK, PASS
data_storage_region (optional)
\n \n
Query Parameter — The data region to use. If not specified, account's default data region will be used.
\n\n\n

Return type

\n
\n inline_response_200_6\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>1 - Unexpected error\n inline_response_200_6\n
\n
\n \n 
post /api/v1/infra/top-graph
\n
Get infrastructure protection top items (graph view) (getInfraProtectTopData)
\n
Use this operation to view the highest peak values and highest average values for a protected IP range during a selected time period.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters. format: int64
ip_range (required)
\n \n
Query Parameter — The customer's IP range.
range_type (required)
\n \n
Query Parameter — One of the following: BGP, PROTECTED_IP, NETFLOW
start (required)
\n \n
Query Parameter — The start date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul> format: int64
end (required)
\n \n
Query Parameter — The end date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul> format: int64
data_type (required)
\n \n
Query Parameter — One of the following: SRC_IP, DST_IP, SRC_PORT_PROTOCOL, DST_PORT_PROTOCOL
metric_type (required)
\n \n
Query Parameter — One of the following: BW, PPS
mitigation_type (required)
\n \n
Query Parameter — One of the following: BLOCK, PASS
data_storage_region (optional)
\n \n
Query Parameter — The data region to use. If not specified, account's default data region will be used.
objects (optional)
\n \n
Query Parameter — A comma separated list of items to fetch data for. e.g., 10.10.10.10, 2.2.2.2. If not specified, top items are automatically fetched.
\n\n\n

Return type

\n
\n inline_response_200_7\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>1 - Unexpected error\n inline_response_200_7\n
\n
\n \n 
post /api/v1/infra/top-table
\n
Get infrastructure protection top items (table view) (getInfraProtectTopTable)
\n
Use this operation to view the highest peak values and highest average values for a protected IP range during a selected time period.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters. format: int64
ip_range (required)
\n \n
Query Parameter — The customer's IP range.
range_type (required)
\n \n
Query Parameter — One of the following: BGP, PROTECTED_IP, NETFLOW
start (required)
\n \n
Query Parameter — The start date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul> format: int64
end (required)
\n \n
Query Parameter — The end date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul> format: int64
data_type (required)
\n \n
Query Parameter — One of the following: SRC_IP, DST_IP, SRC_PORT_PROTOCOL, DST_PORT_PROTOCOL
metric_type (required)
\n \n
Query Parameter — One of the following: BW, PPS
mitigation_type (required)
\n \n
Query Parameter — One of the following: BLOCK, PASS
aggregation_type (required)
\n \n
Query Parameter — One of the following: PEAK, AVERAGE
data_storage_region (optional)
\n \n
Query Parameter — The data region to use. If not specified, account's default data region will be used.
\n\n\n

Return type

\n
\n inline_response_200_8\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>1 - Unexpected error\n inline_response_200_8\n
\n
\n \n 
post /api/v1/infra/stats
\n
Get infrastructure protection statistics (getInfraStats)
\n
Use this operation to get Infrastructure Protection event information for an account.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to operate on.<br/>If not specified, operation will be performed on the account identified by the authentication parameters. format: int64
ip_prefix (optional)
\n \n
Query Parameter — Specific Protected IP or IP range. For example, 1.1.1.0/24.
traffic (optional)
\n \n
Query Parameter — Specific traffic. One of: Total, Passed, Blocked.
traffic_type (optional)
\n \n
Query Parameter — A comma separated list of specific traffic types. Any of: UDP, TCP, DNS, DNS_RESPONSE, ICMP, SYN, FRAG, LARGE_SYN, NTP, NETFLOW, SSDP, GENERAL. Cannot be used together with the pop parameter.
pop (optional)
\n \n
Query Parameter — A comma separated list of specific PoP names. For example: iad, tko. Cannot be used together with the traffic_type parameter. For the list of PoP codes and locations, see <a href="https://docs.imperva.com/csh?context=pops">Imperva Data Centers (PoPs)</a>.
start (optional)
\n \n
Query Parameter — The start date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul> format: int64
end (optional)
\n \n
Query Parameter — The end date in milliseconds, since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul> format: int64
directionTypes (optional)
\n \n
Query Parameter — The type of direction(INGRESS/EGRESS) to filter the data
range_type (optional)
\n \n
Query Parameter — Can be one of the following: BGP, PROTECTED_IP, NETFLOW
\n\n\n

Return type

\n
\n inline_response_200_9\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>3015 - Internal error\n inline_response_200_9\n
\n
\n \n 
post /api/stats/v1
\n
Get statistics (getStats)
\n
Get site statistics for one or more sites. This operation may return multiple statistics, as specified in the stats parameter.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (optional)
\n \n
Query Parameter — Numeric identifier of the account to fetch data for.<br/>Note: You must specify either account_id or site_id.
time_range (required)
\n \n
Query Parameter — Time range to fetch data for.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul>
start (optional)
\n \n
Query Parameter — Start date in milliseconds since January 1, 1970 (midnight UTC/GMT). Used together with the time_range parameter to specify a custom time range.
end (optional)
\n \n
Query Parameter — End date in milliseconds since January 1, 1970 (midnight UTC/GMT). Used together with the time_range parameter to specify a custom time range.
site_id (optional)
\n \n
Query Parameter — Numeric identifier of the site to fetch data for. Multiple sites can be specified in a comma separated list. For example: 123,124,125.<br/>Note: You must specify either account_id or site_id.
stats (required)
\n \n
Query Parameter — Statistics to fetch, as specified in the table below. Multiple statistics can be specified in a comma separated list.<br/>Values for the stats parameters:<br/><ul><li><b>visits_timeseries</b> Number of sessions by type (Humans/Bots) over time.</li><li><b>hits_timeseries</b> Number of requests by type (Humans/Bots/Blocked) over time and per second.</li><li><b>bandwidth_timeseries</b> Amount of bytes (bandwidth) and bits per second (throughput) transferred via the Imperva network from clients to proxy servers and vice-versa over time.</li><li><b>requests_geo_dist_summary</b> Total number of requests routed via the Imperva network by data center location.</li><li><b>visits_dist_summary</b> Total number of sessions per client application and country.</li><li><b>caching</b> Total number of requests and bytes that were cached by the Imperva network.</li><li><b>caching_timeseries</b> Number of requests and bytes that were cached by the Imperva network, with one day resolution, with info regarding the caching mode (standard or advanced).</li><li><b>threats</b> Total number of threats by type with additional information regarding the security rules configuration.</li><li><b>incap_rules</b> List of security rules with total number of reported incidents for each rule.</li><li><b>incap_rules_timeseries</b> List of security rules with a series of reported incidents for each rule with the specified granularity.</li><li><b>delivery_rules</b> List of delivery rules with total number of hits for each rule.</li><li><b>delivery_rules_timeseries</b> List of delivery rules with a series of hits for each rule with the specified granularity.</li></ul>
granularity (optional)
\n \n
Query Parameter — Time interval in milliseconds between data points for time series statistics. (See the timeseries values in the table below.)<br/>The default granularity depends on the specified time range, as follows:<br/><ul><li>Time range of less than 24 hours: Default granularity is 7200000 (2 hours).</li><li>Time range of between 24 hours and 30 days: Default granularity is 86400000 (1 day).</li><li>Time range of more than 30 days: Default granularity is 259200000 (3 days).</li></ul>The response includes one result for each interval. For example, if you specify a time range value of last_7_days, the default granularity is 1 day, and the response will return 7 results.<br/>The response timestamps are in milliseconds since January 1, 1970 (midnight UTC/GMT)<br/>Minimum granularity is 5 minutes (300000).<br/>Note: Time series statistics are presented oldest to newest.<br/>
\n\n\n

Return type

\n
\n inline_response_200_10\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/> 13001 (Timerange invalid), 13002 (Granularity invalid)\n inline_response_200_10\n
\n
\n \n 
post /api/visits/v1
\n
Get visits (getVisits)
\n
Use this operation to get a log of recent visits to a website.
\n\n\n\n\n\n

Query parameters

\n
\n
site_id (required)
\n \n
Query Parameter — Numeric identifier of the site to operate on.
time_range (optional)
\n \n
Query Parameter — Time range to fetch data for. Default is last_7_days.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul>
start (optional)
\n \n
Query Parameter — Start date in milliseconds since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul>
end (optional)
\n \n
Query Parameter — End date in milliseconds since 1970.<br/>Some operations require the user to specify a time range. This is done via the time_range parameter, which accepts the following values:<br/><ul><li><b>today</b> Retrieve data from midnight today until the current time.</li><li><b>last_7_days</b> Retrieve data from midnight of 7 days ago until the current time.</li><li><b>last_30_days</b> Retrieve data from midnight of 30 days ago until the current time.</li><li><b>last_90_days</b> Retrieve data from midnight of 90 days ago until the current time.</li><li><b>month_to_date</b> Retrieve data from midnight of the first day of the month until the current time.</li><li><b>custom</b> Specify a custom time range using two additional parameters: start and end.<br/>Results are provided for full days only, starting from midnight. A time range of less than 24 hours gives results for the full day.<br/>For example:<ul><li>A time range of 14:00 - 20:00 yesterday gives results for all of yesterday (midnight to midnight) - a full day.</li><li>A time range of 14:00 last Tuesday to 14:00 last Wednesday gives results for all of Tuesday and Wednesday - two full days.</li> <li>A time range of 14:00 yesterday to 14:00 today gives results for all of yesterday starting from midnight until the current time today.</li></ul></li></ul>
page_size (optional)
\n \n
Query Parameter — The number of objects to return in the response. Defaults to 10. Maximum is 100.
page_num (optional)
\n \n
Query Parameter — The page to return starting from 0. Default to 0.
security (optional)
\n \n
Query Parameter — Filter the sessions that were handled according to the security-related specifications. Multiple values are supported, e.g.: &quot;api.threats.sql_injection, api.acl.blacklisted_ips&quot;.
country (optional)
\n \n
Query Parameter — Filter the sessions coming from the specified country.
ip (optional)
\n \n
Query Parameter — Filter the sessions coming from the specified IP.
visit_id (optional)
\n \n
Query Parameter — Comma separated list of visit IDs to load.
list_live_visits (optional)
\n \n
Query Parameter — Whether or not to list visits that did not end and that may still be updated.<br/>Possible values: true, false<br/>Default: true
use_previous_region (optional)
\n \n
Query Parameter — Whether or not to list visits from old region data. Valid only if a data region was changed in the last 90 days. One of: true | false. Default: false
\n\n\n

Return type

\n
\n inline_response_200_11\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>1 - Unexpected error\n inline_response_200_11\n
\n
\n \n 
post /api/logscollector/upload/publickey
\n
Upload public key (uploadLCPublicKey)
\n
Available only for Enterprise Plan customers that purchased the Security Logs Integration SKU.
\n\n\n\n\n\n

Query parameters

\n
\n
config_id (required)
\n \n
Query Parameter — The Logs Collector configuration identifier.
public_key (required)
\n \n
Query Parameter — The public key file (2048bit) in base64 format (without password protection).
\n\n\n

Return type

\n
\n inline_response_200_12\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
""
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>13008 - Invalid configuration ID<br/>13009 - Invalid key length<br/>13007 - Invalid public key\n inline_response_200_12\n

WAFLogSetup

\n
\n \n 
post /api/prov/v1/waf-log-setup/activate
\n
Activate WAF Logs (activate)
\n
Use this operation to activate WAF Logs
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on. format: int64
\n\n\n

Return type

\n
\n ApiResultWAFLogSetupActivate\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ],\n  "logs_collector_config_id" : 0\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>9403 - Unknown/unauthorized account id<br/>9414 - Feature not permitted<br/>1- Unexpected error<br/>6002- Invalid configuration parameter value\n ApiResultWAFLogSetupActivate\n
\n
\n \n 
post /api/prov/v1/waf-log-setup/change/status
\n
Change logs collector configuration status (changeStatus)
\n
Change the status of the Logs Collector configuration.
\n\n\n\n\n\n

Query parameters

\n
\n
account_id (required)
\n \n
Query Parameter — Numeric identifier of the account to operate on. format: int64
config_id (required)
\n \n
Query Parameter — The Logs Collector configuration identifier. format: int64
logs_config_new_status (required)
\n \n
Query Parameter — The new configuration status of the Logs Collector.\nPossible values: ACTIVE, SUSPENDED
\n\n\n

Return type

\n
\n ApiResult\n \n
\n\n \n\n

Example data

\n
Content-Type: application/json
\n 
{\n  "res" : 0,\n  "res_message" : "OK",\n  "debug_info" : [ {\n    "key" : { }\n  }, {\n    "key" : { }\n  } ]\n}
\n\n

Produces

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

Responses

\n

200

\n res - contains the specific error code:<br/>2 - Invalid input<br/>13008 - Invalid configuration ID\n ApiResult\n

Models

Methods

Table of Contents

    \n
  1. ADRule
    2. \n
  2. ADRuleSeries
    3. \n
  3. AccountBandwidth
    4. \n
  4. AccountPlanStatus
    5. \n
  5. AccountPlanStatus_websiteProtection
    6. \n
  6. ActionItem
    7. \n
  7. AnalyticsHistogramApiResponse
    8. \n
  8. AnalyticsTopGraphDataResponse
    9. \n
  9. AnalyticsTopTableApiResponse
    10. \n
  10. AnalyticsTopTableData
    11. \n
  11. ApiError
    12. \n
  12. ApiErrorResponse
    13. \n
  13. ApiErrorSource
    14. \n
  14. ApiResult
    15. \n
  15. ApiResultAccountStatus
    16. \n
  16. ApiResultAccountSubscription
    17. \n
  17. ApiResultAddCacheRule
    18. \n
  18. ApiResultDomainEmails
    19. \n
  19. ApiResultGetCacheMode
    20. \n
  20. ApiResultGetClappsInfo
    21. \n
  21. ApiResultGetResponseHeaderSettings
    22. \n
  22. ApiResultGetRewritePorts
    23. \n
  23. ApiResultGetSecureResources
    24. \n
  24. ApiResultGetSiteXrayLink
    25. \n
  25. ApiResultGetSsoToken
    26. \n
  26. ApiResultGetTagResponseHeader
    27. \n
  27. ApiResultGetTexts
    28. \n
  28. ApiResultHtmlInjections
    29. \n
  29. ApiResultIncapsulaRanges
    30. \n
  30. ApiResultInfraProtectSipCname
    31. \n
  31. ApiResultInfraProtectSipDnsWithCname
    32. \n
  32. ApiResultInfraProtectSipDnsWithIp
    33. \n
  33. ApiResultInfraProtectSipIp
    34. \n
  34. ApiResultLCPublicKey
    35. \n
  35. ApiResultListSites
    36. \n
  36. ApiResultListUsers
    37. \n
  37. ApiResultMoveSite
    38. \n
  38. ApiResultReport
    39. \n
  39. ApiResultSessions
    40. \n
  40. ApiResultSetDataRegion
    41. \n
  41. ApiResultSetSupportDeprecatedTLSForSite
    42. \n
  42. ApiResultSiteStats
    43. \n
  43. ApiResultSiteStatus
    44. \n
  44. ApiResultSubAccountStatus
    45. \n
  45. ApiResultTestAlert
    46. \n
  46. ApiResultTestAlertConnectionStatus
    47. \n
  47. ApiResultTestAlertExporterStatus
    48. \n
  48. ApiResultTestAlertProtectedIPStatus
    49. \n
  49. ApiResultWAFLogSetupActivate
    50. \n
  50. BotConfiguration
    51. \n
  51. BotsConfiguration
    52. \n
  52. BotsConfigurationDTO
    53. \n
  53. CaaComplianceCheckResult
    54. \n
  54. Caching
    55. \n
  55. CreateNewCSRResponse
    56. \n
  56. CustomRuleResponse
    57. \n
  57. DataCenterConfiguration
    58. \n
  58. DataCenterResponse
    59. \n
  59. DataCenterServerConfiguration
    60. \n
  60. DataCentersConfiguration
    61. \n
  61. DataCentersConfigurationDTO
    62. \n
  62. DeleteCustomRuleResponse
    63. \n
  63. DeliveryRuleDTO
    64. \n
  64. DeliveryRulesListDTO
    65. \n
  65. DetectionPolicyResponse
    66. \n
  66. DnsInstructionItem
    67. \n
  67. ForwardToDcRuleDTO
    68. \n
  68. ForwardToPortRuleDTO
    69. \n
  69. GeoInfo
    70. \n
  70. GetAdvancedCachingSettingsApiResult
    71. \n
  71. GetCache404SettingsApiResult
    72. \n
  72. GetStaleContentApiResult
    73. \n
  73. HSTSConfiguration
    74. \n
  74. HtmlInjectionItem
    75. \n
  75. IncapRule
    76. \n
  76. IncapRuleApiResult
    77. \n
  77. IncapRuleSeries
    78. \n
  78. InfraEventsApiResponse
    79. \n
  79. InfraProtectEvent
    80. \n
  80. InfraStatsApiResponse
    81. \n
  81. IsCacheShieldEnabledApiResult
    82. \n
  82. ListCustomRulesResponse
    83. \n
  83. ListDataCenterResponse
    84. \n
  84. Login
    85. \n
  85. LoginProtectApiResult
    86. \n
  86. LoginProtectUsersApiResults
    87. \n
  87. LpExtendedUser
    88. \n
  88. MonitoringPolicyRevisionDto
    89. \n
  89. MonitoringPolicyRevisionResponse
    90. \n
  90. PerformanceConfigurationApiResult
    91. \n
  91. PlanSection
    92. \n
  92. PlanSectionRow
    93. \n
  93. PopRttResponse
    94. \n
  94. RecommendedPopsApiResult
    95. \n
  95. RedirectRuleDTO
    96. \n
  96. RequestBodyTimeoutDTO
    97. \n
  97. RequestsGeo
    98. \n
  98. RewritePort
    99. \n
  99. RewriteRequestCookieRuleDTO
    100. \n
  100. RewriteRequestDeleteCookieRuleDTO
    101. \n
  101. RewriteRequestDeleteHeaderRuleDTO
    102. \n
  102. RewriteRequestHeaderRuleDTO
    103. \n
  103. RewriteRequestUrlRuleDTO
    104. \n
  104. RewriteResponseCodeRuleDTO
    105. \n
  105. RewriteResponseCustomErrorRuleDTO
    106. \n
  106. RewriteResponseDeleteHeaderRuleDTO
    107. \n
  107. RewriteResponseHeaderRuleDTO
    108. \n
  108. SecurityPolicyResponse
    109. \n
  109. SecurityPolicyResponse_singleIpThresholds
    110. \n
  110. SecurityPolicyRevisionResponse
    111. \n
  111. ServerOperationResponse
    112. \n
  112. SessionItem
    113. \n
  113. SetPriorityResponse
    114. \n
  114. SimplifiedRedirectRuleDTO
    115. \n
  115. SiteCacheRuleResponse
    116. \n
  116. SiteConfigurationWarning
    117. \n
  117. SiteDualFactorSettings
    118. \n
  118. Stats
    119. \n
  119. SubAccountStatus
    120. \n
  120. TLSConfiguration
    121. \n
  121. TLSConfigurationDto
    122. \n
  122. Threat
    123. \n
  123. ThreatItem
    124. \n
  124. ThresholdsData
    125. \n
  125. TimeSeriesItem
    126. \n
  126. TopGraphPayloads
    127. \n
  127. VisitsItem
    128. \n
  128. VisitsSummary
    129. \n
  129. account
    130. \n
  130. accounts
    131. \n
  131. customAreas
    132. \n
  132. customAreasExceptions
    133. \n
  133. inline_response_200
    134. \n
  134. inline_response_200_1
    135. \n
  135. inline_response_200_10
    136. \n
  136. inline_response_200_11
    137. \n
  137. inline_response_200_12
    138. \n
  138. inline_response_200_13
    139. \n
  139. inline_response_200_14
    140. \n
  140. inline_response_200_15
    141. \n
  141. inline_response_200_16
    142. \n
  142. inline_response_200_17
    143. \n
  143. inline_response_200_18
    144. \n
  144. inline_response_200_19
    145. \n
  145. inline_response_200_2
    146. \n
  146. inline_response_200_20
    147. \n
  147. inline_response_200_21
    148. \n
  148. inline_response_200_22
    149. \n
  149. inline_response_200_23
    150. \n
  150. inline_response_200_24
    151. \n
  151. inline_response_200_25
    152. \n
  152. inline_response_200_26
    153. \n
  153. inline_response_200_27
    154. \n
  154. inline_response_200_28
    155. \n
  155. inline_response_200_29
    156. \n
  156. inline_response_200_3
    157. \n
  157. inline_response_200_30
    158. \n
  158. inline_response_200_31
    159. \n
  159. inline_response_200_32
    160. \n
  160. inline_response_200_33
    161. \n
  161. inline_response_200_34
    162. \n
  162. inline_response_200_35
    163. \n
  163. inline_response_200_36
    164. \n
  164. inline_response_200_37
    165. \n
  165. inline_response_200_38
    166. \n
  166. inline_response_200_39
    167. \n
  167. inline_response_200_4
    168. \n
  168. inline_response_200_40
    169. \n
  169. inline_response_200_41
    170. \n
  170. inline_response_200_42
    171. \n
  171. inline_response_200_43
    172. \n
  172. inline_response_200_44
    173. \n
  173. inline_response_200_45
    174. \n
  174. inline_response_200_5
    175. \n
  175. inline_response_200_6
    176. \n
  176. inline_response_200_7
    177. \n
  177. inline_response_200_8
    178. \n
  178. inline_response_200_9
    179. \n
  179. specific_users_list
    180. \n
\n

ADRule

\n \n
\n
id (optional)
String
\n
name (optional)
String
\n
action (optional)
String
\n
example: Redirect
\n
createdAt (optional)
Date format: date-time
\n
updatedBy (optional)
String
\n
example: example@imperva.com
\n
hits (optional)
Long format: int64
\n
example: 3451
\n
\n
\n

ADRuleSeries

\n \n
\n
id (optional)
String
\n
name (optional)
String
\n
action (optional)
String
\n
example: Redirect
\n
createdAt (optional)
Date format: date-time
\n
updatedBy (optional)
String
\n
example: example@imperva.com
\n
hits (optional)
array[Object]
\n
example: [[1478613600000,6],[1478617200000,3]]
\n
\n
\n

AccountBandwidth

\n \n
\n
billingCycle (optional)
String
\n
example: Earlier billing cycle
\n
onDemandBandwidth (optional)
String
\n
example: 0bps
\n
alwaysOnBandwidth (optional)
String
\n
example: 7.7kbps
\n
\n
\n

AccountPlanStatus

\n \n
\n
accountId (optional)
Long format: int64
\n
example: 12345
\n
accountName (optional)
String
\n
example: demo_account@incapsula.com
\n
websiteProtection (optional)
array[AccountPlanStatus_websiteProtection]
\n
example: {"name":"Website Protection","planSectionRows":[{"name":"Additional Sites","purchased":"100","used":"2"},{"name":"Load Balancing (old)","purchased":"0","used":"0"},{"name":"Additional Login Protect Users","purchased":"5","used":"0"}]}
\n
infrastructureProtection (optional)
array[AccountPlanStatus_websiteProtection]
\n
example: {"name":"Infrastructure Protection","planSectionRows":[{"name":"On Demand Bandwidth (Clean traffic)","purchased":"0","used":""},{"name":"GRE Tunnel Pairs","purchased":"0 ","used":"0"}]}
\n
dnsProtection (optional)
array[AccountPlanStatus_websiteProtection]
\n
example: {"name":"DNS Protection","planSectionRows":[{"name":"Additional DNS Zones","purchased":"0","used":"0"}]}
\n
additionalServices (optional)
array[AccountPlanStatus_websiteProtection]
\n
example: {"name":"Additional Services","planSectionRows":[{"name":"Always On Bandwidth (Clean traffic)","purchased":"10Mbps","used":"N/A"},{"name":"DDoS Protection","purchased":"None","used":""},{"name":"Support Level","purchased":"Standard","used":"Standard"},{"name":"WAF SIEM Integration","purchased":"10","used":"0"},{"name":"Web Attack Analytics","purchased":"0","used":""}]}
\n
\n
\n

AccountPlanStatus_websiteProtection

\n \n
\n
name (optional)
String
\n
planSectionRows (optional)
array[PlanSectionRow]
\n
\n
\n

ActionItem

\n \n
\n
queryString (optional)
String
\n
example: ?jobSYapi_password\\u003dXXXXX
\n
postData (optional)
String
\n
requestResult (optional)
String requestResult
\n
example: api.request_result.req_challenge_javascript
\n
isSecured (optional)
Boolean
\n
example: false
\n
url (optional)
String
\n
example: www.google.com/ddos/ddos-mitigation-services
\n
httpStatus (optional)
Integer format: int32
\n
example: 200
\n
responseTime (optional)
Long format: int64
\n
example: 170
\n
thinkTime (optional)
Long format: int64
\n
example: 169
\n
incidentId (optional)
String
\n
example: 3411008890000033213-29571073433152
\n
threats (optional)
array[ThreatItem]
\n
\n
\n

AnalyticsHistogramApiResponse

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
stats (optional)
array[map[String, Object]]
\n
example: {"PL_100":"366450640","PL_200":"305475960","PL_300":"0","PL_400":"0","PL_500":"0","PL_600":"0","PL_700":"0","PL_800":"0","PL_900":"0","PL_1000":"0","PL_1100":"0","PL_1200":"0","PL_1300":"0","PL_1400":"0","PL_1500":"0"}
\n
\n
\n

AnalyticsTopGraphDataResponse

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
stats (optional)
array[Stats]
\n
\n
\n

AnalyticsTopTableApiResponse

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
stats (optional)
array[AnalyticsTopTableData]
\n
\n
\n

AnalyticsTopTableData

\n \n
\n
object (optional)
String
\n
example: 10.200.98.3
\n
value (optional)
Double format: double
\n
example: 334160
\n
\n
\n

ApiError

\n \n
\n
id (optional)
String Globally unique error id.
\n
example: 01234567-0123-0123-0123-0123456789ab
\n
status (optional)
String HTTP status code
\n
example: 404
\n
code (optional)
String Error code
\n
example: ERROR_2002
\n
message (optional)
String Detailed error message
\n
example: Site 123456 not found
\n
source (optional)
ApiErrorSource
\n
\n
\n

ApiErrorResponse

\n \n
\n
errors (optional)
array[ApiError]
\n
\n
\n

ApiErrorSource

\n
Pointer to source of error
\n
\n
pointer (optional)
String a JSON Pointer [RFC6901] to the erroneous JSON element in the request payload
\n
example: $.data[0].fieldName
\n
parameter (optional)
String The name of erroneous query/path parameter name
\n
example: extSiteId
\n
\n
\n

ApiResult

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
\n
\n

ApiResultAccountStatus

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
account (optional)
account
\n
\n
\n

ApiResultAccountSubscription

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
planStatus (optional)
AccountPlanStatus
\n
bandwidthHistory (optional)
array[AccountBandwidth]
\n
\n
\n

ApiResultAddCacheRule

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
rule_id (optional)
Long format: int64
\n
example: 10
\n
\n
\n

ApiResultDomainEmails

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
domain_emails (optional)
array[Object]
\n
\n
\n

ApiResultGetCacheMode

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
cache_mode (optional)
String
\n
example: static_and_dynamic
\n
\n
\n

ApiResultGetClappsInfo

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
clientApps (optional)
array[map[String, Object]]
\n
example: {"1":"Firefox"}
\n
clientAppTypes (optional)
array[map[String, Object]]
\n
example: {"1":"Browser"}
\n
\n
\n

ApiResultGetResponseHeaderSettings

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
enabled (optional)
Boolean
\n
example: true
\n
mode (optional)
String
\n
example: CUSTOM
\n
custom_headers (optional)
array[String]
\n
\n
\n

ApiResultGetRewritePorts

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
port (optional)
RewritePort
\n
ssl_port (optional)
RewritePort
\n
\n
\n

ApiResultGetSecureResources

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
secured_resources_mode (optional)
String
\n
example: do_not_cache (i.e. Do not cache HTTPS resources)
\n
\n
\n

ApiResultGetSiteXrayLink

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
url (optional)
String
\n
example: https://
\n
\n
\n

ApiResultGetSsoToken

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
generated_token (optional)
String
\n
example: 344ebcaf34dff34
\n
\n
\n

ApiResultGetTagResponseHeader

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
header (optional)
String
\n
example: h1
\n
\n
\n

ApiResultGetTexts

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
texts (optional)
array[map[String, Object]]
\n
example: {"api.stats.visits_timeseries.human":"Human visits","api.stats.visits_timeseries.bot":"Bot visits","api.threats.followup.view":"View Incidents"}
\n
\n
\n

ApiResultHtmlInjections

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
html_injections (optional)
array[HtmlInjectionItem]
\n
\n
\n

ApiResultIncapsulaRanges

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
ipRanges (optional)
array[Object]
\n
ipv6Ranges (optional)
array[Object]
\n
\n
\n

ApiResultInfraProtectSipCname

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
edge_ip (optional)
String
\n
example: 172.17.14.1
\n
cname (optional)
String
\n
example: imperva.test.com
\n
\n
\n

ApiResultInfraProtectSipDnsWithCname

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
edge_ip (optional)
String
\n
example: 172.17.14.1
\n
resolved_cnames (optional)
array[String]
\n
cname (optional)
String
\n
example: imperva.test.com
\n
\n
\n

ApiResultInfraProtectSipDnsWithIp

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
edge_ip (optional)
String
\n
example: 172.17.14.1
\n
resolved_ips (optional)
array[String]
\n
origin_ip (optional)
String
\n
example: 157.166.249.10
\n
\n
\n

ApiResultInfraProtectSipIp

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
edge_ip (optional)
String
\n
example: 172.17.14.1
\n
origin_ip (optional)
String
\n
example: 1.2.3.4
\n
\n
\n

ApiResultLCPublicKey

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
publicKeyId (optional)
Long format: int64
\n
example: 1
\n
\n
\n

ApiResultListSites

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
ApiResultSiteStatus (optional)
array[ApiResultSiteStatus]
\n
\n
\n

ApiResultListUsers

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
accounts (optional)
array[accounts]
\n
\n
\n

ApiResultMoveSite

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
status (optional)
String
\n
Enum:
\n
MOVED
PENDING_CA_APPROVAL
FAILED
\n
\n
\n

ApiResultReport

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
format (optional)
String
\n
Enum:
\n
html
xml
amf
pdf
flash
json
mail
csv
statistics
syslog
\n
example: pdf
\n
report (optional)
String
\n
example: JVBERi0xLjUNCiXvv73vv73vv73vv70NCjEgMCBvYmoNCjw8L1R5cGUvQ2F0YWxvZy9QYWdlcyAyIDAgUi9MYW5nKGVuLVVT ...
\n
\n
\n

ApiResultSessions

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
visits (optional)
array[SessionItem]
\n
\n
\n

ApiResultSetDataRegion

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
region (optional)
String
\n
example: US
\n
\n
\n

ApiResultSetSupportDeprecatedTLSForSite

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
support_all_tls_versions (optional)
Boolean
\n
example: true
\n
new_A_record (optional)
String
\n
example: 1.2.3.4
\n
additional_instructions (optional)
String
\n
example: After the site is moved, update the site’s 'A' records according to the information in Websites General Settings.
\n
\n
\n

ApiResultSiteStats

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
visits_timeseries (optional)
array[VisitsItem]
\n
requests_geo_dist_summary (optional)
RequestsGeo
\n
visits_dist_summary (optional)
array[VisitsSummary]
\n
caching (optional)
Caching
\n
caching_timeseries (optional)
array[TimeSeriesItem]
\n
hits_timeseries (optional)
array[TimeSeriesItem]
\n
bandwidth_timeseries (optional)
array[TimeSeriesItem]
\n
threats (optional)
array[Threat]
\n
incap_rules (optional)
array[IncapRule]
\n
incap_rules_timeseries (optional)
array[IncapRuleSeries]
\n
delivery_rules (optional)
array[ADRule]
\n
delivery_rules_timeseries (optional)
array[ADRuleSeries]
\n
\n
\n

ApiResultSiteStatus

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
site_id (optional)
Long format: int64
\n
example: 10
\n
statusEnum (optional)
String
\n
Enum:
\n
pending-txt-validation
pending-dns-changes
fully-configured
pending-select-approver
pending-certificate
unknown
\n
example: pending-dns-changes
\n
status (optional)
String
\n
example: pending-dns-changes
\n
domain (optional)
String
\n
example: admin@example.com
\n
account_id (optional)
Long format: int64
\n
example: 1
\n
acceleration_level (optional)
String
\n
example: advanced
\n
acceleration_level_raw (optional)
String
\n
example: none
\n
site_creation_date (optional)
Long format: int64
\n
example: 1610396346000
\n
ips (optional)
array[Object]
\n
dns (optional)
array[DnsInstructionItem]
\n
original_dns (optional)
array[DnsInstructionItem]
\n
warnings (optional)
array[SiteConfigurationWarning]
\n
active (optional)
String
\n
Enum:
\n
active
bypass
\n
example: active
\n
support_all_tls_versions (optional)
Boolean
\n
example: true
\n
use_wildcard_san_instead_of_full_domain_san (optional)
Boolean
\n
example: true
\n
add_naked_domain_san (optional)
Boolean
\n
example: true
\n
set_site_cookies_without_domain (optional)
Boolean
\n
example: true
\n
enable_http_between_Imperva_and_origin (optional)
String
\n
example: 80
\n
additionalErrors (optional)
array[Object]
\n
display_name (optional)
String
\n
example: loginprotectapi1610396334653.incaptest.info
\n
security (optional)
array[map[String, Object]]
\n
example: {"waf":{"rules":[{"id":"api.threats.bot_access_control","name":"Bot Access Control","block_bad_bots":true,"challenge_suspected_bots":true},{"id":"api.threats.sql_injection","name":"SQL Injection","action":"api.threats.action.block_request","action_text":"Block Request"},{"id":"api.threats.cross_site_scripting","name":"Cross Site Scripting (XSS)","exceptions":[{"values":[{"urls":[{"value":"/gsddg","pattern":"EQUALS"}],"id":"api.rule_exception_type.url","name":"URL"}],"id":244711494}],"action":"api.threats.action.alert","action_text":"Alert Only"},{"id":"api.threats.illegal_resource_access","name":"Illegal Resource Access","action":"api.threats.action.block_user","action_text":"Block User"},{"id":"api.threats.ddos","name":"DDoS","activation_mode":"api.threats.ddos.activation_mode.off","activation_mode_text":"Off","ddos_traffic_threshold":"api.threats.ddos.ddos_trassic_threshold","ddos_traffic_threshold_text":"750","ddos_adaptive_threshold":"500","ddos_adaptive_threshold_last_update_time":"1610396346000"},{"id":"api.threats.backdoor","name":"Backdoor Protect","action":"api.threats.action.quarantine_url","action_text":"Auto-Quarantine"},{"action":"api.threats.action.block_ip","action_text":"Block IP","id":"api.threats.remote_file_inclusion","name":"Remote File Inclusion"}]},"acls":{"rules":[{"ips":["2.3.4.5"],"exceptions":[{"values":[{"id":"api.rule_exception_type.url","name":"URL","urls":[{"value":"/home","pattern":"EQUALS"}]}],"id":493271006}],"id":"api.acl.blacklisted_ips","name":"Visitors from denylisted IPs"}]}}
\n
ssl (optional)
array[map[String, Object]]
\n
example: {"origin_server":{"detected":"true","detectionStatus":"ok"}}
\n
siteDualFactorSettings (optional)
SiteDualFactorSettings
\n
requestBodyTimeouts (optional)
RequestBodyTimeoutDTO
\n
login_protect (optional)
LoginProtectApiResult
\n
performance_configuration (optional)
PerformanceConfigurationApiResult
\n
extended_ddos (optional)
Integer format: int32
\n
incap_rules (optional)
array[IncapRuleApiResult]
\n
restricted_cname_reuse (optional)
Boolean
\n
example: true
\n
\n
\n

ApiResultSubAccountStatus

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
sub_account (optional)
SubAccountStatus
\n
\n
\n

ApiResultTestAlert

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
ip_prefix (optional)
String
\n
example: 100.1.2.0/24
\n
status (optional)
String
\n
example: DDoS start notification sent successfully
\n
\n
\n

ApiResultTestAlertConnectionStatus

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
ip_prefix (optional)
String
\n
example: 100.1.2.0/24
\n
status (optional)
String
\n
example: DDoS start notification sent successfully
\n
connection_name (optional)
String
\n
example: CONNECTION_NAME
\n
\n
\n

ApiResultTestAlertExporterStatus

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
ip_prefix (optional)
String
\n
example: 100.1.2.0/24
\n
status (optional)
String
\n
example: DDoS start notification sent successfully
\n
\n
\n

ApiResultTestAlertProtectedIPStatus

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
ip_prefix (optional)
String
\n
example: 100.1.2.0/24
\n
status (optional)
String
\n
example: DDoS start notification sent successfully
\n
ip (optional)
String
\n
example: 1.2.3.4
\n
\n
\n

ApiResultWAFLogSetupActivate

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
logs_collector_config_id (optional)
Long format: int64
\n
\n
\n

BotConfiguration

\n \n
\n
id
Long The ID number assigned to the bot, according to Imperva’s client classification database. format: int64
\n
example: 6
\n
displayName (optional)
String The bot name and type, according to Imperva’s client classification database. <br> This field is relevant for response only
\n
example: Googlebot (Search Bot)
\n
\n
\n

BotsConfiguration

\n \n
\n
canceledGoodBots (optional)
array[BotConfiguration] Bots that an account user has removed from the list of bots that Imperva allows to access your website by default.
\n
badBots (optional)
array[BotConfiguration] Bots that an account user has added to the list of bots that Imperva blocks by default.
\n
\n
\n

BotsConfigurationDTO

\n \n
\n
data (optional)
array[BotsConfiguration]
\n
\n
\n

CaaComplianceCheckResult

\n \n
\n
res (optional)
Integer format: int32
\n
res_message (optional)
String
\n
non_compliant_sans (optional)
array[Object]
\n
\n
\n

Caching

\n \n
\n
saved_requests (optional)
Long format: int64
\n
example: 23984923
\n
total_requests (optional)
Long format: int64
\n
example: 48723648
\n
saved_bytes (optional)
Long format: int64
\n
example: 762394786
\n
total_bytes (optional)
Long format: int64
\n
example: 1098349834
\n
\n
\n

CreateNewCSRResponse

\n \n
\n
csr_content (optional)
String
\n
example: -----BEGIN CERTIFICATE REQUEST-----\\nMIIC5DCCAcwCAQAwgZ4xNTAzBgNVBAMTLGEucmV1c2VjdXN0b21jZXJ0aWZpY2F0\\nZXdpdGhjc3J0ZXN0MzUzOTYuY29tMQwwCgYDVQQHEwNKRVIxCzAJBgNVBAYTAklM\\nMQswCQYDVQQIEwJJTDEQMA4GA1UEChMHaW1wZXJ2YTELMAkGA1UECxMCQ04xHjAc\\nBgkqhkiG9w0BCQEWD2Zvb0BpbXBlcnZhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQAD\\nggEPADCCAQoCggEBAMAHcUrB5rhio8jaAueo6rdpgW1SuscfiiK01xZF5utOqrQ2\\nSfD3IBaQcT6pf9fFT5zUcErXmCpjdabY42JmjiRvS04aKhI4pKydM17e5CSevSyM\\n0gAYhUdQOgjpCY81/58RKwndG3diFbsdrGnDuKWf7kLmx/biK+3IIZxSPF7JsQ1i\\nDHzS9X1Sq3Hwk7GBwOLBlKqG6VXS3SMUReggW6VJhuCKlY+FPUuT7Qr80fkfVt8x\\nbCFle7gMF8v390Tc36FFXF7/Jo5m9aSgFLFPRPsbJ+UlRxvRXrnLNm+ycCcXvL5A\\ngE50PJaCHJz4U45c9zSAKbrvGHKzZ6eWkdVCDfsCAwEAAaAAMA0GCSqGSIb3DQEB\\nCwUAA4IBAQAvRrtUP86lG3J+uYrtnvZzDGRue6eIVwfDOKqrPBAX3fm+JnctZKC5\\nQVmLToMFKRyL/FsF3K4a9hf8pN5TjT2/LS7OvgOHOfQC0eZCcocRmz++MtUaQxsx\\n+WHiUkpgnXnH3KQhj3WzP6HJV/qjRzcRWBsHUhuE75/J0153RWEXQssC5y4t3hvl\\nynkT6BUkQDy8XdRA3kgahPd9Jnwx4be9pRuq7hw1JIA7jFqu4A/ZSoUAoCqgWIfD\\nXSt26/4tt4DItt+G/SLGNPuhuc2z+VmGkDDrRm8SNfykEvHFlKkdYcSKgLH2+fgf\\nlCCHPIALjavOirG+cki5Ppc0M/Wmagl+\\n-----END CERTIFICATE REQUEST-----\\n
\n
status (optional)
String
\n
example: ok
\n
res (optional)
String
\n
example: 0
\n
\n
\n

CustomRuleResponse

\n \n
\n
rule_id (optional)
Long format: int64
\n
example: 43573
\n
status (optional)
String
\n
example: ok
\n
res (optional)
Integer format: int32
\n
example: 0
\n
\n
\n

DataCenterConfiguration

\n \n
\n
name
String Data center name
\n
example: London DC
\n
id (optional)
Long Data center id format: int64
\n
example: 7543
\n
ipMode (optional)
String Load-balancing mode.<br/>Possible values:<ul><li><b>SINGLE_IP</b> - Use it only when you need to support multiple ports. Allows a single active server listening on multiple ports, plus the option of a single standby server. Traffic is distributed across the server ports.<br/><b>Note</b>: The server address must be a valid IP address (i.e. not host/domain name).<br/>SINGLE_IP is applicable only for datacenters. It may not be used when dataCenterMode = ‘SINGLE_SERVER’.</li><li><b>MULTIPLE_IP</b> – Allows one or more origin servers having a single webserver and listening port per server. Traffic is distributed across servers.</li></ul>
\n
Enum:
\n
SINGLE_IP
MULTIPLE_IP
\n
example: MULTIPLE_IP
\n
webServersPerServer (optional)
Integer When IP mode = SINGLE_IP, number of webservers per server. Each webserver listens to different port. E.g. when webServersPerServer = 5, HTTP traffic will use ports 80-84 while HTTPS traffic will use ports 443-447 format: int32
\n
example: 5
\n
lbAlgorithm (optional)
String Specifies how to load balance between the servers of this data center
\n
Enum:
\n
LB_LEAST_PENDING_REQUESTS
LB_LEAST_OPEN_CONNECTIONS
LB_SOURCE_IP_HASH
RANDOM
WEIGHTED
\n
example: WEIGHTED
\n
weight (optional)
Integer Weight in pecentage. Mandatory if lbAlgorithm = WEIGHTED_LB. Then, total weights of all data centers must be equal to 100 format: int32
\n
example: 40
\n
isEnabled (optional)
Boolean For each site, at least one data center must be enabled
\n
example: false
\n
isActive (optional)
Boolean Specify false to define a standby datacenter. No more than one data center can be defined as standby. Failover to standby data center is performed only when no other active data center is available
\n
example: false
\n
isContent (optional)
Boolean When true, this data center will only handle requests that were routed to it using application delivery forward rules. If true, must be an active data center.
\n
example: true
\n
isRestOfTheWorld (optional)
Boolean When global lbAlgorithm = GEO_PREFERRED or GEO_REQUIRED, exactly one data center must have isRestOfTheWorld = true. This data center will handle traffic from any region that is not assigned to a specific data center.
\n
example: true
\n
geoLocations (optional)
array[String]
\n
Enum:
\n \n
originPop (optional)
String The ID of the PoP that serves as an access point between Imperva and the customer’s origin server. For example: &quot;lax&quot;, for Los Angeles. When not specified, all Imperva PoPs can send traffic to this data center. The list of available PoPs is documented at: https://docs.imperva.com/bundle/cloud-application-security/page/more/pops.htm
\n
example: lax
\n
servers (optional)
array[DataCenterServerConfiguration]
\n
\n
\n

DataCenterResponse

\n \n
\n
datacenter_id (optional)
Integer format: int32
\n
example: 484377
\n
status (optional)
String
\n
example: ok
\n
res (optional)
String
\n
example: 0
\n
\n
\n

DataCenterServerConfiguration

\n \n
\n
address
String Server address as: host name, ipv4, or ipv6
\n
example: 1.2.3.4
\n
id (optional)
Long Server id format: int64
\n
example: 7543
\n
isEnabled (optional)
Boolean For each data center, at least one server must be enabled
\n
example: false
\n
serverMode (optional)
String Single IP allows single active server plus optionally single standny server. Each server may have multiple webservers (listening to different port). Multiple IPs allow multiple servers having single webserver and listening port per server.
\n
Enum:
\n
ACTIVE
STANDBY
\n
weight (optional)
Integer Weight in percentage. Mandatory when Data center's lbAlgorithm = WEIGHTED format: int32
\n
example: 70
\n
\n
\n

DataCentersConfiguration

\n \n
\n
lbAlgorithm (optional)
String Specifies how to load balance between multiple data centers
\n
Enum:
\n
BEST_CONNECTION_TIME
GEO_PREFERRED
GEO_REQUIRED
WEIGHTED_LB
\n
example: GEO_PREFERRED
\n
failOverRequiredMonitors (optional)
String How many Imperva PoPs should assess Data Center as down before failover is performed.MANY means more than one. MOST means more than 50%.
\n
Enum:
\n
ONE
MANY
MOST
ALL
\n
example: MANY
\n
dataCenterMode (optional)
String SINGLE_SERVER does not allow load balancing. SINGLE_DC allows load balancing and/or failover between its servers. MULTIPLE_DC allows load balancing and/or failover between the data centers plus geo aware routing.
\n
Enum:
\n
SINGLE_SERVER
SINGLE_DC
MULTIPLE_DC
\n
example: MULTIPLE_DC
\n
minAvailableServersForDataCenterUp (optional)
Integer The minimal number of available data center's servers to consider that data center as UP format: int32
\n
example: 3
\n
kickStartURL (optional)
String The URL that will be sent to the standby server when Imperva performs failover based on our monitoring. Port must be specified, if protocol is https.
\n
example: https://www.example.com:443/kickStart
\n
kickStartUser (optional)
String The kickstart user, if kickstart URL is protected by user and password
\n
example: kickstart-user
\n
kickStartPass (optional)
String The kickstart password, if kickstart URL is protected by user and password
\n
example: kickstart-pass
\n
isPersistent (optional)
Boolean When true our proxy servers will maintain session stickiness to origin servers by a cookie
\n
example: false
\n
dataCenters (optional)
array[DataCenterConfiguration]
\n
\n
\n

DeleteCustomRuleResponse

\n \n
\n
status (optional)
String
\n
example: ok
\n
res (optional)
Integer format: int32
\n
example: 0
\n
\n
\n

DeliveryRuleDTO

\n
Delivery rule DTO
\n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
\n
\n

DeliveryRulesListDTO

\n \n
\n
data (optional)
array[DeliveryRuleDTO]
\n
\n
\n

DetectionPolicyResponse

\n \n
\n
data (optional)
map[String, array[map[String, String]]]
\n
example: {"TOTAL":[],"OTHER":[{"amount":"150.0 Mbps","time":"Over 30 sec"},{"amount":"10.0K PPS","time":"Over 45 sec"},{"amount":"30.0K PPS","time":"Over 15 sec"}],"TCP":[{"amount":"200.0 Mbps","time":"Over 30 sec"},{"amount":"70.0K PPS","time":"Over 30 sec"},{"amount":"100.0K PPS","time":"Over 15 sec"}],"UDP":[{"amount":"200.0 Mbps","time":"Over 30 sec"},{"amount":"90.0 Mbps","time":"Over 60 sec"},{"amount":"80.0K PPS","time":"Over 45 sec"}],"FRAG":[{"amount":"25.0 Mbps","time":"Over 30 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"10.0K PPS","time":"Over 30 sec"}],"DNS":[{"amount":"10.0K PPS","time":"Over 30 sec"},{"amount":"25.0K PPS","time":"Over 15 sec"}],"SYN":[{"amount":"20.0K PPS","time":"Over 30 sec"},{"amount":"17.0K PPS","time":"Over 75 sec"}],"LARGE_SYN":[{"amount":"25.0 Mbps","time":"Over 30 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"10.0K PPS","time":"Over 30 sec"}],"SSDP":[{"amount":"25.0 Mbps","time":"Over 30 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"10.0K PPS","time":"Over 30 sec"}],"NTP":[{"amount":"25.0 Mbps","time":"Over 45 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"10.0K PPS","time":"Over 30 sec"}],"ICMP":[{"amount":"25.0 Mbps","time":"Over 30 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"20.0K PPS","time":"Over 30 sec"}]}
\n
\n
\n

DnsInstructionItem

\n \n
\n
dns_record_name (optional)
String
\n
example: loginprotectapi1610396334653.incaptest.info
\n
set_type_to (optional)
String
\n
Enum:
\n
CNAME
A
AAAA
MX
NS
TXT
Unkown
CAA
\n
example: CNAME
\n
set_data_to (optional)
array[Object]
\n
\n
\n

ForwardToDcRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
dc_id
Long Data center ID to forward the request to format: int64
\n
example: 123456
\n
\n
\n

ForwardToPortRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
port_forwarding_context
String Context for port forwarding. &quot;header&quot; or &quot;port&quot;
\n
example: port
\n
port_forwarding_value
String Port number or header name for port forwarding
\n
example: 80
\n
\n
\n

GeoInfo

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
countriesCodes (optional)
array[map[String, Object]]
\n
example: {"BD":"Bangladesh","BE":"Belgium"}
\n
continentsCodes (optional)
array[map[String, Object]]
\n
example: {"AF":"Africa"}
\n
\n
\n

GetAdvancedCachingSettingsApiResult

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
value (optional)
Boolean
\n
example: true
\n
\n
\n

GetCache404SettingsApiResult

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
enabled (optional)
Boolean
\n
example: true
\n
time (optional)
Integer format: int32
\n
example: 10
\n
time_unit (optional)
String
\n
example: HOURS
\n
\n
\n

GetStaleContentApiResult

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
enabled (optional)
Boolean
\n
example: false
\n
mode (optional)
String
\n
example: ADAPTIVE
\n
time (optional)
Integer format: int32
\n
example: 10
\n
unit (optional)
String
\n
example: HOURS
\n
\n
\n

HSTSConfiguration

\n
HTTP Strict transport security (HSTS) ensures that any attempt by visitors to use the unsecure version (http://) of a page will be forwarded automatically to the secure version (https://).
\n
\n
isEnabled (optional)
Boolean Enable/disable HSTS support for this website
\n
maxAge (optional)
Long (TTL) The amount of time in seconds to apply HSTS in the browser before attempting to load the page using http://. format: int64
\n
example: 7543
\n
subDomainsIncluded (optional)
Boolean Enforce HSTS on sub-domains. For example, a page listed on xxx.ddd.com uses resources from images.ddd.com. If HSTS for sub-domains is enabled, the images are also covered. Make sure that the site and all sub-domains support HTTPS so that HSTS does not break an internal resource when rendering the page.
\n
preLoaded (optional)
Boolean The most secure way to enforce HSTS. Ensures the first request goes out in a secure tunnel, since the browser already has that URL in the pre-load list. The domain needs to be listed at https://hstspreload.appspot.com/.
\n
\n
\n

HtmlInjectionItem

\n \n
\n
url (optional)
String
\n
example: /
\n
url_pattern (optional)
String
\n
Enum:
\n
EQUALS
NOT_EQUALS
NOT_CONTAINS
PREFIX
SUFFIX
NOT_PREFIX
NOT_SUFFIX
CONTAINS
\n
example: prefix
\n
location (optional)
String
\n
example: head
\n
content (optional)
String
\n
example: Some content
\n
\n
\n

IncapRule

\n \n
\n
id (optional)
String
\n
name (optional)
String
\n
action (optional)
String
\n
example: Require Javascript Support
\n
incidents (optional)
Long format: int64
\n
example: 3451
\n
createdAt (optional)
Date format: date-time
\n
updatedBy (optional)
String
\n
example: example@imperva.com
\n
\n
\n

IncapRuleApiResult

\n \n
\n
id (optional)
Long format: int64
\n
example: 123
\n
name (optional)
String
\n
example: Block Click Worms
\n
action (optional)
String
\n
example: api.rule_action_type.rule_action_block
\n
rule (optional)
String
\n
example: ClientIP == 1.2.3.4
\n
creation_date (optional)
Long format: int64
\n
updated_by (optional)
String
\n
example: John
\n
updated_at (optional)
Long format: int64
\n
example: 1611228121241
\n
comment (optional)
String
\n
example: rule comment
\n
\n
\n

IncapRuleSeries

\n \n
\n
id (optional)
String
\n
name (optional)
String
\n
action (optional)
String
\n
example: Require Javascript Support
\n
createdAt (optional)
Date format: date-time
\n
updatedBy (optional)
String
\n
example: example@imperva.com
\n
incidents (optional)
array[Object]
\n
example: [[1478613600000,6],[1478617200000,3]]
\n
\n
\n

InfraEventsApiResponse

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
events (optional)
array[InfraProtectEvent]
\n
\n
\n

InfraProtectEvent

\n \n
\n
eventTime (optional)
Date format: date-time
\n
eventType (optional)
String
\n
Enum:
\n
GRE_TUNNEL_UP
GRE_TUNNEL_DOWN
ORIGIN_CONNECTION_GRE_UP
ORIGIN_CONNECTION_GRE_DOWN
ORIGIN_CONNECTION_ECX_UP
ORIGIN_CONNECTION_ECX_DOWN
ORIGIN_CONNECTION_CROSS_CONNECT_UP
ORIGIN_CONNECTION_CROSS_CONNECT_DOWN
IP_RANGE_ATTACK_START
IP_RANGE_ATTACK_STOP
DDOS_START_IP_RANGE
DDOS_STOP_IP_RANGE
DDOS_QUIET_TIME_IP_RANGE
EXPORTER_NO_DATA
EXPORTER_BAD_DATA
EXPORTER_GOOD_DATA
MONITORING_ATTACK
MONITORING_CRITICAL_ATTACK
PROTECTED_IP_STATUS_UP
PROTECTED_IP_STATUS_DOWN
PROTECTED_NETWORK_STATUS_ACTIVE
PROTECTED_NETWORK_STATUS_INACTIVE
PER_IP_DDOS_START_IP_RANGE
PER_IP_DDOS_STOP_IP_RANGE
IIP_ACCOUNT_SERVICE_SUSPENDED
IIP_ACCOUNT_SERVICE_UNSUSPENDED
INFRAPROTECT_NULL_ROUTE_STARTED
INFRAPROTECT_NULL_ROUTE_ESCALATED
INFRAPROTECT_NULL_ROUTE_ENDED
INFRAPROTECT_RANGE_DIVERT
INFRAPROTECT_RANGE_REVERT
BGP_UP
BGP_DOWN
CONNECTION_PERFORMANCE_DEGRADED
CONNECTION_PERFORMANCE_RESTORED
\n
example: DDOS_STOP_IP_RANGE
\n
bwTotal (optional)
Long format: int64
\n
example: 9000
\n
ppsTotal (optional)
Long format: int64
\n
example: 90
\n
bwPassed (optional)
Long format: int64
\n
example: 200
\n
ppsPassed (optional)
Long format: int64
\n
example: 87
\n
bwBlocked (optional)
Long format: int64
\n
example: 8800
\n
ppsBlocked (optional)
Long format: int64
\n
example: 3
\n
eventTarget (optional)
String
\n
Enum:
\n
GRE_TUNNEL
IP_RANGE
EXPORTER
PROTECTED_IP
INCAPSULA_IP
NULL_ROUTE
BGP
\n
example: IP_RANGE
\n
reportedByPop (optional)
String
\n
example: zrh
\n
\n
\n

InfraStatsApiResponse

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
\n
\n

IsCacheShieldEnabledApiResult

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
enabled (optional)
Boolean
\n
example: true
\n
\n
\n

ListCustomRulesResponse

\n \n
\n
incap_rules (optional)
array[map[String, Object]]
\n
example: {"All":[{"id":"3660","last_7_days_requests_count":"0","name":"Ortal","action":"RULE_ACTION_ALERT","filter":""}]}
\n
delivery_rules (optional)
array[map[String, Object]]
\n
example: {"Redirect":[{"to":"/home.php","id":"3648","priority":"1","last_7_days_requests_count":"0","name":"Test new","action":"RULE_ACTION_REWRITE_URL","from":"*/home.html","filter":"ASN == 1"}],"Forward":[{"id":"3628","priority":"2","last_7_days_requests_count":"0","name":"move to rewrite","dc_id":"54313","action":"RULE_ACTION_FORWARD_TO_DC","filter":""}]}
\n
rate_rules (optional)
array[map[String, Object]]
\n
example: {"Rates":[{"id":"4723","enabled":"true","interval":"120","name":"Test Rate IP","context":"IP","action":"RULE_ACTION_RATE","internal_name":"test-rate-ip","filter":"ASN == 2"}]}
\n
\n
\n

ListDataCenterResponse

\n \n
\n
\n
\n

Login

\n \n
\n
login_id (optional)
String
\n
example: demo_account@incapsula.com
\n
email_verified (optional)
Boolean
\n
example: true
\n
\n
\n

LoginProtectApiResult

\n \n
\n
enabled (optional)
Boolean
\n
example: true
\n
specific_users_list (optional)
array[specific_users_list]
\n
send_lp_notifications (optional)
Boolean
\n
example: true
\n
allow_all_users (optional)
Boolean
\n
example: true
\n
authentication_methods (optional)
array[Object]
\n
urls (optional)
array[Object]
\n
url_patterns (optional)
array[Object]
\n
\n
\n

LoginProtectUsersApiResults

\n \n
\n
users (optional)
array[LpExtendedUser]
\n
\n
\n

LpExtendedUser

\n \n
\n
email (optional)
String email
\n
example: John@example.com
\n
name (optional)
String name
\n
example: John Doe
\n
status (optional)
String status
\n
example: INVITATION_SENT
\n
phone (optional)
String phone
\n
example: 1-8662507658
\n
creation_date (optional)
Date creation_date format: date-time
\n
\n
\n

MonitoringPolicyRevisionDto

\n \n
\n
data (optional)
map[String, array[map[String, String]]] Data
\n
lastUpdate (optional)
String LastUpdated time
\n
\n
\n

MonitoringPolicyRevisionResponse

\n \n
\n
policyRevisions (optional)
array[MonitoringPolicyRevisionDto]
\n
example: [{"data":{"TCP":[{"amount":"100.0K PPS","time":"Over 15 sec"},{"amount":"70.0K PPS","time":"Over 30 sec"},{"amount":"200.0 Mbps","time":"Over 30 sec"}],"UDP":[{"amount":"80.0K PPS","time":"Over 45 sec"},{"amount":"200.0 Mbps","time":"Over 30 sec"},{"amount":"90.0 Mbps","time":"Over 60 sec"}],"OTHER":[{"amount":"30.0K PPS","time":"Over 15 sec"},{"amount":"10.0K PPS","time":"Over 45 sec"},{"amount":"150.0 Mbps","time":"Over 30 sec"}],"FRAG":[{"amount":"10.0K PPS","time":"Over 30 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"25.0 Mbps","time":"Over 30 sec"}],"DNS":[{"amount":"25.0K PPS","time":"Over 15 sec"},{"amount":"10.0K PPS","time":"Over 30 sec"}],"SYN":[{"amount":"20.0K PPS","time":"Over 30 sec"},{"amount":"17.0K PPS","time":"Over 75 sec"}],"LARGE_SYN":[{"amount":"10.0K PPS","time":"Over 30 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"25.0 Mbps","time":"Over 30 sec"}],"SSDP":[{"amount":"10.0K PPS","time":"Over 30 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"25.0 Mbps","time":"Over 30 sec"}],"NTP":[{"amount":"10.0K PPS","time":"Over 30 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"25.0 Mbps","time":"Over 45 sec"}],"ICMP":[{"amount":"20.0K PPS","time":"Over 30 sec"},{"amount":"40.0 Mbps","time":"Over 15 sec"},{"amount":"25.0 Mbps","time":"Over 30 sec"}]},"lastUpdate":"2023-05-02T06:18:51Z"}]
\n
\n
\n

PerformanceConfigurationApiResult

\n \n
\n
advanced_caching_rules (optional)
array[map[String, Object]]
\n
example: {"never_cache_resources":[{"pattern":"SUFFIX","url":"/test.html"}],"always_cache_resources":[{"pattern":"NOT_EQUALS","url":"/index.html","ttl":"5","ttlUnits":"SECONDS"},{"pattern":"EQUALS","url":"/home.html","ttl":"6","ttlUnits":"DAYS"}]}
\n
acceleration_level (optional)
String
\n
example: advanced
\n
acceleration_level_raw (optional)
String
\n
example: none
\n
async_validation (optional)
Boolean
\n
example: true
\n
minify_javascript (optional)
Boolean
\n
example: true
\n
minify_css (optional)
Boolean
\n
example: true
\n
minify_static_html (optional)
Boolean
\n
example: true
\n
compress_jpeg (optional)
Boolean
\n
example: true
\n
compress_jepg (optional)
Boolean
\n
example: true
\n
progressive_image_rendering (optional)
Boolean
\n
example: true
\n
aggressive_compression (optional)
Boolean
\n
example: true
\n
compress_png (optional)
Boolean
\n
example: true
\n
on_the_fly_compression (optional)
Boolean
\n
example: true
\n
tcp_pre_pooling (optional)
Boolean
\n
example: true
\n
comply_no_cache (optional)
Boolean
\n
example: true
\n
comply_vary (optional)
Boolean
\n
example: true
\n
use_shortest_caching (optional)
Boolean
\n
example: true
\n
perfer_last_modified (optional)
Boolean
\n
example: true
\n
prefer_last_modified (optional)
Boolean
\n
example: true
\n
disable_client_side_caching (optional)
Boolean
\n
example: true
\n
cache300x (optional)
Boolean
\n
example: true
\n
cache_headers (optional)
array[Object]
\n
\n
\n

PlanSection

\n \n
\n
name (optional)
String
\n
planSectionRows (optional)
array[PlanSectionRow]
\n
\n
\n

PlanSectionRow

\n \n
\n
name (optional)
String
\n
purchased (optional)
String
\n
used (optional)
String
\n
\n
\n

PopRttResponse

\n \n
\n
id (optional)
String
\n
example: ord
\n
name (optional)
String
\n
example: Chicago, IL
\n
region (optional)
String
\n
example: US Central
\n
rtt (optional)
Integer format: int32
\n
example: 8
\n
\n
\n

RecommendedPopsApiResult

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
pops (optional)
array[PopRttResponse]
\n
reason (optional)
String
\n
example: N/A
\n
\n
\n

RedirectRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
from
String URL to redirect from
\n
example: /path/from
\n
to
String URL to redirect to
\n
example: http://site.to
\n
response_code
Integer Rule's response code. format: int32
\n
Enum:
\n
301
302
303
307
308
\n
example: 302
\n
\n
\n

RequestBodyTimeoutDTO

\n \n
\n
methods (optional)
array[Object]
\n
interval (optional)
Integer format: int32
\n
byteCount (optional)
Integer format: int32
\n
requestBodyTimeouts (optional)
RequestBodyTimeoutDTO
\n
\n
\n

RequestsGeo

\n \n
\n
id (optional)
String
\n
name (optional)
String
\n
data (optional)
array[Object]
\n
example: [['Tokyo, JA',24365435],['Los Angeles, CA',98762738]]
\n
\n
\n

RewritePort

\n \n
\n
from (optional)
String
\n
to (optional)
String
\n
\n
\n

RewriteRequestCookieRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
cookie_name
String Name of cookie to rewrite
\n
example: cookie_name
\n
from (optional)
String Cookie value to rewrite
\n
example: original cookie value
\n
to
String Cookie value to change to
\n
example: new cookie value
\n
rewrite_existing (optional)
Boolean Rewrite cookie if it exists
\n
example: true
\n
add_if_missing (optional)
Boolean Add cookie if it doesn't exist
\n
example: false
\n
\n
\n

RewriteRequestDeleteCookieRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
cookie_name
String Name of cookie to delete
\n
example: cookie_name
\n
\n
\n

RewriteRequestDeleteHeaderRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
header_name
String Name of header to delete
\n
example: header_name
\n
multiple_headers_deletion (optional)
Boolean Delete multiple header occurrences
\n
example: false
\n
\n
\n

RewriteRequestHeaderRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
header_name
String Name of header to rewrite
\n
example: header_name
\n
from (optional)
String Header value to rewrite
\n
example: original header value
\n
to
String Header value to change to
\n
example: new header value
\n
rewrite_existing (optional)
Boolean Rewrite header if it exists
\n
example: true
\n
add_if_missing (optional)
Boolean Add header if it doesn't exist
\n
example: false
\n
\n
\n

RewriteRequestUrlRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
from (optional)
String URL value to rewrite
\n
example: /from
\n
to
String URL value to change to
\n
example: /to
\n
\n
\n

RewriteResponseCodeRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
response_code (optional)
Integer rule's response code. valid values are all 3-digits numbers. format: int32
\n
example: 404
\n
\n
\n

RewriteResponseCustomErrorRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
error_response_format
String The format of the given error response in the error_response_data field.
\n
Enum:
\n
json
xml
\n
example: json
\n
error_response_data
String The response returned when the request matches the filter and is blocked.
\n
example: {<br> "incidentId" : "$INCIDENT_ID$",<br> "hostName" : "$HOST_NAME$",<br> "errorCode" : "$RR_CODE$",<br> "description" : "$RR_DESCRIPTION$",<br> "timeUtc" : "$TIME_UTC$",<br> "clientIp" : "$CLIENT_IP$",<br> "proxyId" : "$PROXY_ID$",<br> "proxyIp" : "$PROXY_IP$"<br> }
\n
error_type
String The error that triggers the rule. <code>error.type.all</code> triggers the rule regardless of the error type.
\n
Enum:
\n
error.type.all
error.type.connection_timeout
error.type.access_denied
error.type.parse_req_error
error.type.parse_resp_error
error.type.connection_failed
error.type.deny_and_retry
error.type.ssl_failed
error.type.deny_and_captcha
error.type.2fa_required
error.type.no_ssl_config
error.type.no_ipv6_config
error.type.waiting_room
\n
example: error.type.all
\n
response_code
Integer rule's response code. format: int32
\n
Enum:
\n
303
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
419
420
422
423
424
429
500
501
502
503
504
505
507
200
\n
example: 404
\n
\n
\n

RewriteResponseDeleteHeaderRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
header_name
String Name of header to delete
\n
example: header_name
\n
multiple_headers_deletion (optional)
Boolean Delete multiple header occurrences
\n
example: false
\n
\n
\n

RewriteResponseHeaderRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
filter (optional)
String Defines the conditions that trigger the rule action
\n
example: Content-Type == "application/json"
\n
header_name
String Name of header to rewrite
\n
example: header_name
\n
from (optional)
String Header value to rewrite
\n
example: original header value
\n
to
String Header value to change to
\n
example: new header value
\n
rewrite_existing (optional)
Boolean Rewrite header if it exists
\n
example: true
\n
add_if_missing (optional)
Boolean Add header if it doesn't exist
\n
example: false
\n
\n
\n

SecurityPolicyResponse

\n \n
\n
singleIpThresholds (optional)
array[SecurityPolicyResponse_singleIpThresholds] thresholds for IP
\n
ipRangeThresholds (optional)
array[SecurityPolicyResponse_singleIpThresholds] thresholds for Subnet
\n
lastUpdate (optional)
String LastUpdated time
\n
\n
\n

SecurityPolicyResponse_singleIpThresholds

\n \n
\n
ppsThresholds (optional)
map[String, String]
\n
bandwidthThresholds (optional)
map[String, String]
\n
\n
\n

SecurityPolicyRevisionResponse

\n \n
\n
policyRevisions (optional)
array[SecurityPolicyResponse]
\n
example: [{"singleIpThresholds":{"ppsThresholds":{"UDP":"10.0K PPS","TCP":"50.0K PPS","TOTAL":"50.0K PPS","DNS_RESPONSE":"0.3K PPS","DNS":"0.3K PPS","SYN":"0.5K PPS","SSDP":"0.3K PPS","NTP":"0.3K PPS","OTHER":"3.0K PPS","FRAG":"0.3K PPS","CUSTOM":"0.3K PPS","LARGE_SYN":"0.3K PPS","ICMP":"0.3K PPS"},"bandwidthThresholds":{"UDP":"10.0 Mbps","TCP":"50.0 Mbps","TOTAL":"50.0 Mbps","DNS_RESPONSE":"0.2 Mbps","DNS":"0.1 Mbps","SYN":"0.4 Mbps","SSDP":"0.1 Mbps","NTP":"0.1 Mbps","OTHER":"8.0 Mbps","FRAG":"0.1 Mbps","CUSTOM":"0.1 Mbps","LARGE_SYN":"0.1 Mbps","ICMP":"0.1 Mbps"}},"ipRangeThresholds":{"ppsThresholds":{"UDP":"10.0K PPS","TCP":"50.0K PPS","TOTAL":"50.0K PPS","DNS_RESPONSE":"0.3K PPS","DNS":"0.3K PPS","SYN":"0.5K PPS","SSDP":"0.3K PPS","NTP":"0.3K PPS","OTHER":"3.0K PPS","FRAG":"0.3K PPS","CUSTOM":"0.3K PPS","LARGE_SYN":"0.3K PPS","ICMP":"0.3K PPS"},"bandwidthThresholds":{"UDP":"10.0 Mbps","TCP":"50.0 Mbps","TOTAL":"50.0 Mbps","DNS_RESPONSE":"0.2 Mbps","DNS":"0.1 Mbps","SYN":"0.4 Mbps","SSDP":"0.1 Mbps","NTP":"0.1 Mbps","OTHER":"8.0 Mbps","FRAG":"0.1 Mbps","CUSTOM":"0.1 Mbps","LARGE_SYN":"0.1 Mbps","ICMP":"0.1 Mbps"}},"lastUpdate":"2023-10-09T07:06:36Z"},{"singleIpThresholds":{"ppsThresholds":{"UDP":"10.0K PPS","TCP":"50.0K PPS","TOTAL":"50.0K PPS","DNS_RESPONSE":"0.3K PPS","DNS":"0.3K PPS","SYN":"0.5K PPS","SSDP":"0.3K PPS","NTP":"0.3K PPS","OTHER":"3.0K PPS","FRAG":"0.3K PPS","CUSTOM":"0.3K PPS","LARGE_SYN":"0.3K PPS","ICMP":"0.3K PPS"},"bandwidthThresholds":{"UDP":"10.0 Mbps","TCP":"50.0 Mbps","TOTAL":"50.0 Mbps","DNS_RESPONSE":"0.2 Mbps","DNS":"0.1 Mbps","SYN":"0.4 Mbps","SSDP":"0.1 Mbps","NTP":"0.1 Mbps","OTHER":"8.0 Mbps","FRAG":"0.1 Mbps","CUSTOM":"0.1 Mbps","LARGE_SYN":"0.1 Mbps","ICMP":"0.1 Mbps"}},"ipRangeThresholds":{"ppsThresholds":{"UDP":"10.0K PPS","TCP":"50.0K PPS","TOTAL":"50.0K PPS","DNS_RESPONSE":"0.3K PPS","DNS":"0.3K PPS","SYN":"0.5K PPS","SSDP":"0.3K PPS","NTP":"0.3K PPS","OTHER":"3.0K PPS","FRAG":"0.3K PPS","CUSTOM":"0.3K PPS","LARGE_SYN":"0.3K PPS","ICMP":"0.3K PPS"},"bandwidthThresholds":{"UDP":"10.0 Mbps","TCP":"50.0 Mbps","TOTAL":"50.0 Mbps","DNS_RESPONSE":"0.2 Mbps","DNS":"0.1 Mbps","SYN":"0.4 Mbps","SSDP":"0.1 Mbps","NTP":"0.1 Mbps","OTHER":"8.0 Mbps","FRAG":"0.1 Mbps","CUSTOM":"0.1 Mbps","LARGE_SYN":"0.1 Mbps","ICMP":"0.1 Mbps"}},"lastUpdate":"2022-09-01T08:30:14Z"}]
\n
\n
\n

ServerOperationResponse

\n \n
\n
server_id (optional)
String
\n
example: 2
\n
status (optional)
String
\n
example: ok
\n
res (optional)
String
\n
example: 0
\n
\n
\n

SessionItem

\n \n
\n
id (optional)
String
\n
example: 133077760038625792
\n
siteId (optional)
Long format: int64
\n
example: 7
\n
startTime (optional)
Long format: int64
\n
example: 1361468485000
\n
endTime (optional)
Long format: int64
\n
example: 1361468486000
\n
clientIPs (optional)
array[Object]
\n
country (optional)
array[Object]
\n
countryCode (optional)
array[Object]
\n
clientType (optional)
String
\n
example: Unclassified
\n
clientApplication (optional)
String
\n
example: Bot
\n
clientApplicationId (optional)
Long format: int64
\n
example: 0
\n
httpVersion (optional)
String
\n
example: 2.0
\n
clientApplicationVersion (optional)
String
\n
example: 0
\n
userAgent (optional)
String
\n
example: Mozilla/4.0 (compatible; MSIE 5.0; Windows 95; DigExt)
\n
os (optional)
String
\n
example: Windows
\n
osVersion (optional)
String
\n
example: Windows
\n
supportsCookies (optional)
Boolean
\n
example: true
\n
supportsJavaScript (optional)
Boolean
\n
example: true
\n
hits (optional)
Long format: int64
\n
example: 1
\n
pageViews (optional)
Long format: int64
\n
example: 1
\n
entryReferer (optional)
String
\n
example: http://lp.usafis.org/_Incapsula_Resource?CWUDNSAI=9_E1521557&incident_id=133077760038102423-139906691365201416&edet=12&cinfo=2ef678e2c753856785000000
\n
entryPage (optional)
String
\n
example: www.incapsula.com/ddos/ddos-mitigation-services
\n
servedVia (optional)
array[Object]
\n
securitySummary (optional)
array[map[String, Object]]
\n
example: {"api.threats.sql_injection":"2","api.threats.cross_site_scripting":"1","api.threats.illegal_resource_access":"3","api.threats.remote_file_inclusion":"2","api.threats.customRule":"3","api.threats.ddos=DDoS":"4","api.threats.backdoor":"2","api.threats.bot_access_control":"1","api.acl.blacklisted_countries":"1","api.acl.blacklisted_urls":"1","api.acl.blacklisted_ips":"1"}
\n
actions (optional)
array[ActionItem]
\n
\n
\n

SetPriorityResponse

\n \n
\n
status (optional)
String
\n
example: ok
\n
res (optional)
String
\n
example: 0
\n
\n
\n

SimplifiedRedirectRuleDTO

\n \n
\n
rule_name
String The rule name
\n
example: Custom rule 1
\n
action
String Rule action. Possible values: <br/><ul><li><b>RULE_ACTION_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_SIMPLIFIED_REDIRECT</b> Redirect the client to a different URL, responding with a 30X response.</li><li><b>RULE_ACTION_REWRITE_URL</b> Modify the path to which a specific request is targeted.</li><li><b>RULE_ACTION_REWRITE_HEADER</b> Modify or add a request header before passing traffic to the origin server.</li><li><b>RULE_ACTION_REWRITE_COOKIE</b> Modify or add cookies that are sent by the client to the origin server. The cookie name and value should be indicated.</li><li><b>RULE_ACTION_DELETE_HEADER</b> Remove a specific request header, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_DELETE_COOKIE</b> Remove a specific cookie set on the client, which means that it won’t be sent to the origin server.</li><li><b>RULE_ACTION_FORWARD_TO_DC</b> Define the data center to which a specific request will be sent.</li><li><b>RULE_ACTION_FORWARD_TO_PORT</b> Define the port to which a specific request will be sent.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_HEADER</b> Modify or add a header to the response received from the origin server.</li><li><b>RULE_ACTION_RESPONSE_DELETE_HEADER</b> Remove a specific response header, which means that it won't be returned to the client.</li><li><b>RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE</b> Modify the response code received from the origin server.</li><li><b>RULE_ACTION_CUSTOM_ERROR_RESPONSE</b> Control the error response that is returned to the client when a request is blocked.</li></ul>
\n
Enum:
\n
RULE_ACTION_NONE
RULE_ACTION_EXCLUDE
RULE_ACTION_NOP
RULE_ACTION_SESSION_COUNTER_INC
RULE_ACTION_SET_CAPTCHA_FAILED
RULE_ACTION_SET_DUAL_FACTOR_AUTHENTICATION_FAILED
RULE_ACTION_SKIP_TEST_COOKIES
RULE_ACTION_NULL_ROUTE
RULE_ACTION_TRANSPARENT_HTML_JS_FORCE
RULE_ACTION_TRANSPARENT_HTML_JS_RELAXED
RULE_ACTION_HIDDEN_ALERT
RULE_ACTION_ALERT
RULE_ACTION_QUARANTINE_URL
RULE_ACTION_RETRY
RULE_ACTION_INTRUSIVE_HTML
RULE_ACTION_DDOS_ACTION
RULE_ACTION_CAPTCHA
RULE_ACTION_DUAL_FACTOR_AUTHENTICATE
RULE_ACTION_BLOCK
RULE_ACTION_BLOCK_USER
RULE_ACTION_BLOCK_IP
RULE_ACTION_BLOCK_IP_AGGRESSIVE
RULE_ACTION_REDIRECT
RULE_ACTION_REWRITE
RULE_ACTION_BYPASS_CACHE
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKIE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_RATE
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_CUSTOM_ERROR_RESPONSE
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_FORWARD_REQUEST
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_WAF_OVERRIDE
RULE_ACTION_MASK
RULE_ACTION_REDIRECT
RULE_ACTION_SIMPLIFIED_REDIRECT
RULE_ACTION_REWRITE_URL
RULE_ACTION_REWRITE_HEADER
RULE_ACTION_REWRITE_COOKIE
RULE_ACTION_DELETE_HEADER
RULE_ACTION_DELETE_COOKE
RULE_ACTION_FORWARD_TO_DC
RULE_ACTION_FORWARD_TO_PORT
RULE_ACTION_RESPONSE_REWRITE_HEADER
RULE_ACTION_RESPONSE_DELETE_HEADER
RULE_ACTION_RESPONSE_REWRITE_RESPONSE_CODE
RULE_ACTION_CUSTOM_ERROR_RESPONSE
\n
example: RULE_ACTION_REDIRECT
\n
enabled (optional)
Boolean Boolean that enables the rule. Possible values: true, false.
\n
example: true
\n
from
String URL to redirect from
\n
example: /path/from
\n
to
String URL to redirect to
\n
example: http://site.to
\n
response_code
Integer Rule's response code. format: int32
\n
Enum:
\n
301
302
303
307
308
\n
example: 302
\n
\n
\n

SiteCacheRuleResponse

\n \n
\n
\n
\n

SiteConfigurationWarning

\n \n
\n
type (optional)
String
\n
Enum:
\n
CNAME
A
AAAA
MX
NS
TXT
Unkown
CAA
\n
example: CNAME
\n
set_data_to (optional)
array[Object]
\n
\n
\n

SiteDualFactorSettings

\n \n
\n
specificUsers (optional)
array[String]
\n
enabled (optional)
Boolean Enable/disable LoginProtect
\n
example: false
\n
customAreas (optional)
array[customAreas]
\n
customAreasExceptions (optional)
array[customAreasExceptions]
\n
allowAllUsers (optional)
Boolean Authorize all Login Protect users in this account
\n
example: true
\n
shouldSuggestApplicatons (optional)
Boolean
\n
example: true
\n
allowedMedia (optional)
array[String]
\n
Enum:
\n \n
shouldSendLoginNotifications (optional)
Boolean Send Notifications on Login to protected URL
\n
example: true
\n
application (optional)
Boolean
\n
version (optional)
Integer format: int32
\n
\n
\n

Stats

\n \n
\n
res (optional)
Integer res - contains specific error code format: int32
\n
example: 0
\n
res_message (optional)
String
\n
example: OK
\n
debug_info (optional)
array[map[String, Object]]
\n
objectid (optional)
String
\n
example: 200
\n
time (optional)
String
\n
example: 1522761000000
\n
payload (optional)
array[TopGraphPayloads]
\n
\n
\n

SubAccountStatus

\n \n
\n
sub_account_id (optional)
Long format: int64
\n
example: 10
\n
sub_account_name (optional)
String
\n
example: My Sub Account
\n
ref_id (optional)
String
\n
example: 432
\n
logins (optional)
array[Login]
\n
log_level (optional)
String
\n
example: full
\n
support_level (optional)
String
\n
example: Standard
\n
parent_id (optional)
Long format: int64
\n
example: 10
\n
logs_account_id (optional)
Long format: int64
\n
example: 15
\n
\n
\n

TLSConfiguration

\n \n
\n
hstsConfiguration (optional)
HSTSConfiguration
\n
\n
\n

TLSConfigurationDto

\n \n
\n
data (optional)
array[TLSConfiguration]
\n
\n
\n

Threat

\n \n
\n
id (optional)
String
\n
name (optional)
String
\n
incidents (optional)
Long format: int64
\n
example: 12
\n
status (optional)
String
\n
example: ok
\n
status_text_id (optional)
String
\n
example: api.threats.action.block_request
\n
status_text (optional)
String
\n
example: Block Request
\n
followup (optional)
String
\n
example: api.threats.followup.view
\n
followup_text (optional)
String
\n
example: View Incidents
\n
followup_url (optional)
String
\n
example: https://my.incapsula.com/sites/siteVisits?token=1123_103_13234435091_5d55197912387b94&timeFrame=last_7_days&extSiteId=123&threatFilters=badBot
\n
\n
\n

ThreatItem

\n
threats
\n
\n
securityRule (optional)
String
\n
example: api.threats.illegal_resource_access
\n
alertLocation (optional)
String
\n
example: api.alert_location.alert_location_path
\n
attackCodes (optional)
array[Object]
\n
securityRuleAction (optional)
String
\n
example: api.rule_action_type.rule_action_block
\n
\n
\n

ThresholdsData

\n \n
\n
ppsThresholds (optional)
map[String, String]
\n
bandwidthThresholds (optional)
map[String, String]
\n
\n
\n

TimeSeriesItem

\n \n
\n
id (optional)
String
\n
name (optional)
String
\n
data (optional)
array[Object]
\n
example: [[1344247200000,5]]
\n
\n
\n

TopGraphPayloads

\n \n
\n
interval (optional)
String
\n
example: 15000
\n
startTime (optional)
Date format: date-time
\n
data (optional)
array[Object]
\n
example: [5462,7563]
\n
metric (optional)
String
\n
example: pps
\n
dataType (optional)
String
\n
example: ip
\n
item (optional)
String
\n
example: 10.13.0.1
\n
traffic (optional)
String
\n
example: blocked
\n
\n
\n

VisitsItem

\n \n
\n
id (optional)
String
\n
name (optional)
String
\n
data (optional)
array[Object]
\n
example: [[1344247200000,50],[1344247500000,40]]
\n
\n
\n

VisitsSummary

\n \n
\n
id (optional)
String
\n
name (optional)
String
\n
data (optional)
array[array[Object]]
\n
example: [['np',15],['no',778]]
\n
\n
\n

account

\n \n
\n
email (optional)
String
\n
example: example@imperva.com
\n
plan_id (optional)
String
\n
example: ent100
\n
plan_name (optional)
String
\n
example: Enterprise 100
\n
trial_end_date (optional)
Date format: date-time
\n
account_id (optional)
Long format: int64
\n
example: 10
\n
parent_id (optional)
Long format: int64
\n
example: 123
\n
John Account (optional)
String
\n
example: Jhon
\n
user_name (optional)
String
\n
example: Jhon
\n
logins (optional)
array[Login]
\n
log_level (optional)
String
\n
example: full
\n
support_level (optional)
String
\n
example: Standard
\n
support_all_tls_versions (optional)
Boolean
\n
example: true
\n
allow_ssl_validation_delegation (optional)
Boolean
\n
example: true
\n
domains_for_ssl_validation_delegation (optional)
array[String]
\n
cname_value_for_ssl_validation_delegation (optional)
String
\n
example: abc.impervadns.net
\n
wildcard_san_for_new_sites (optional)
String
\n
Enum:
\n
True
False
Default
\n
example: TRUE
\n
naked_domain_san_for_new_www_sites (optional)
Boolean
\n
example: true
\n
enable_http2_for_new_sites (optional)
Boolean
\n
example: true
\n
enable_http2_to_origin_for_new_sites (optional)
Boolean
\n
example: true
\n
\n
\n

accounts

\n \n
\n
email (optional)
String
\n
example: example@imperva.com
\n
plan_id (optional)
String
\n
example: ent100
\n
plan_name (optional)
String
\n
example: Enterprise 100
\n
trial_end_date (optional)
Date format: date-time
\n
account_id (optional)
Long format: int64
\n
example: 10
\n
parent_id (optional)
Long format: int64
\n
example: 123
\n
John Account (optional)
String
\n
example: Jhon
\n
user_name (optional)
String
\n
example: Jhon
\n
logins (optional)
array[Login]
\n
log_level (optional)
String
\n
example: full
\n
support_level (optional)
String
\n
example: Standard
\n
support_all_tls_versions (optional)
Boolean
\n
example: true
\n
allow_ssl_validation_delegation (optional)
Boolean
\n
example: true
\n
domains_for_ssl_validation_delegation (optional)
array[String]
\n
cname_value_for_ssl_validation_delegation (optional)
String
\n
example: abc.impervadns.net
\n
wildcard_san_for_new_sites (optional)
String
\n
Enum:
\n
True
False
Default
\n
example: TRUE
\n
naked_domain_san_for_new_www_sites (optional)
Boolean
\n
example: true
\n
enable_http2_for_new_sites (optional)
Boolean
\n
example: true
\n
enable_http2_to_origin_for_new_sites (optional)
Boolean
\n
example: true
\n
\n
\n

customAreas

\n
Pages or areas on your website requiring extended authentication
\n
\n
pattern (optional)
String
\n
Enum:
\n
EQUALS
NOT_EQUALS
NOT_CONTAINS
PREFIX
SUFFIX
NOT_PREFIX
NOT_SUFFIX
CONTAINS
\n
example: CONTAINS
\n
url (optional)
String
\n
example: /userlist
\n
\n
\n

customAreasExceptions

\n
Pages or areas on your website to exclude from extended authentication
\n
\n
pattern (optional)
String
\n
Enum:
\n
EQUALS
NOT_EQUALS
NOT_CONTAINS
PREFIX
SUFFIX
NOT_PREFIX
NOT_SUFFIX
CONTAINS
\n
example: CONTAINS
\n
url (optional)
String
\n
example: /userlist
\n
\n
\n

inline_response_200

\n \n
\n
\n
\n

inline_response_200_1

\n \n
\n
\n
\n

inline_response_200_10

\n \n
\n
\n
\n

inline_response_200_11

\n \n
\n
\n
\n

inline_response_200_12

\n \n
\n
\n
\n

inline_response_200_13

\n \n
\n
\n
\n

inline_response_200_14

\n \n
\n
\n
\n

inline_response_200_15

\n \n
\n
\n
\n

inline_response_200_16

\n \n
\n
\n
\n

inline_response_200_17

\n \n
\n
\n
\n

inline_response_200_18

\n \n
\n
\n
\n

inline_response_200_19

\n \n
\n
\n
\n

inline_response_200_2

\n \n
\n
\n
\n

inline_response_200_20

\n \n
\n
\n
\n

inline_response_200_21

\n \n
\n
\n
\n

inline_response_200_22

\n \n
\n
\n
\n

inline_response_200_23

\n \n
\n
\n
\n

inline_response_200_24

\n \n
\n
\n
\n

inline_response_200_25

\n \n
\n
\n
\n

inline_response_200_26

\n \n
\n
\n
\n

inline_response_200_27

\n \n
\n
\n
\n

inline_response_200_28

\n \n
\n
\n
\n

inline_response_200_29

\n \n
\n
\n
\n

inline_response_200_3

\n \n
\n
\n
\n

inline_response_200_30

\n \n
\n
\n
\n

inline_response_200_31

\n \n
\n
\n
\n

inline_response_200_32

\n \n
\n
\n
\n

inline_response_200_33

\n \n
\n
\n
\n

inline_response_200_34

\n \n
\n
\n
\n

inline_response_200_35

\n \n
\n
\n
\n

inline_response_200_36

\n \n
\n
\n
\n

inline_response_200_37

\n \n
\n
\n
\n

inline_response_200_38

\n \n
\n
\n
\n

inline_response_200_39

\n \n
\n
\n
\n

inline_response_200_4

\n \n
\n
\n
\n

inline_response_200_40

\n \n
\n
\n
\n

inline_response_200_41

\n \n
\n
\n
\n

inline_response_200_42

\n \n
\n
\n
\n

inline_response_200_43

\n \n
\n
\n
\n

inline_response_200_44

\n \n
\n
\n
\n

inline_response_200_45

\n \n
\n
\n
\n

inline_response_200_5

\n \n
\n
\n
\n

inline_response_200_6

\n \n
\n
\n
\n

inline_response_200_7

\n \n
\n
\n
\n

inline_response_200_8

\n \n
\n
\n
\n

inline_response_200_9

\n \n
\n
\n
\n

specific_users_list

\n \n
\n
email (optional)
String email
\n
example: John@example.com
\n
name (optional)
String name
\n
example: John Doe
\n
status (optional)
String status
\n
example: INVITATION_SENT
\n
\n
\n","topic_language":"enus","views":0,"your_rating":null}