Configuration parameters
apiid— API IDapikey— API keycreds— API IDproxy— Use system proxy settings
Commands (82)
-
incap-add-login-protectUse this operation to add Login Protect user for site.
-
incap-add-managed-accountUse 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 Incapsula. Depending 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 Incapsula 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 Incapsula in the response in the field account_id.
-
incap-add-siteAdd a new site to an account. If the site already exists, its status is returned.
-
incap-add-site-datacenterUse this operation to add a data center to a site.
-
incap-add-site-datacenter-serverUse this operation to add a server to a data center.
-
incap-add-site-html-injection-ruleUse this operation to add a new HTML injection rule or to replace an existing rule.
-
incap-add-site-ruleUse this operation to add a rule (Delivery Rules or IncapRules).
-
incap-add-subaccountUse this operation to add a new sub account to be managed by the account of the API client (the parent account).
-
incap-change-logs-collector-configurationAvailable only for Enterprise Plan customers that purchased the Security Logs Integration SKU. Use this operation to change the status of the Logs Collector configuration.
-
incap-check-complianceCheck 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.
-
incap-configure-appUse this operation to configure Login Protect on wordpress | joomla | phpbb admin areas.
-
incap-create-new-csrUse this operation to create a certificate signing request (CSR) for your site.
-
incap-delete-managed-accountUse this operation to delete an account.
-
incap-delete-siteDelete the site.
-
incap-delete-site-datacenterUse this operation to delete a site's data center.
-
incap-delete-site-datacenter-serverUse this operation to delete a data center's server.
-
incap-delete-site-html-injection-ruleUse this operation to removes an existing HTML injection rule. To confirm the removal, set the parameter delete_content to true.
-
incap-delete-site-ruleUse this operation to delete a rule (Delivery Rules or IncapRules).
-
incap-delete-subaccountUse this operation to delete a sub account.
-
incap-edit-login-protectUse this operation to edit Login Protect user's settings.
-
incap-edit-site-datacenterUse this operation to edit a site's data center.
-
incap-edit-site-datacenter-serverUse this operation to add a server to a data center.
-
incap-edit-site-ruleUse this operation to edit an existing rule (Delivery Rules or IncapRules).
-
incap-enable-site-ruleUse this operation to enable or disable a rule (Delivery Rules or IncapRules).
-
incap-get-account-audit-eventsUse this operation to get audit events for an account.
-
incap-get-account-default-data-storage-regionUse this operation to get the default data region of the account.
-
incap-get-account-login-tokenTokens are used instead of user/password based authentication to log in to the Incapsula management console. Use this operation to generate a token for an account. The token is valid for 15 minutes. In order to use the token, the user must use the following link: https://my.incapsula.com/?token={generated_token}.
-
incap-get-account-statusUse this operation to get information about the account of the API client or one of its managed accounts.
-
incap-get-app-infoUse this operation to retrieve a list of all the client applications.
-
incap-get-domain-approver-emailUse this operation to get the list of email addresses that can be used when adding an SSL site.
-
incap-get-geo-infoUse this operation to retrieve a list of all the countries and continents codes.
-
incap-get-infra-protection-eventsUse this operation to get Infrastructure Protection event information for an account.
-
incap-get-infra-protection-statisticsUse this operation to get Infrastructure Protection statistics for an account or IP range.
-
incap-get-infra-protection-top-items-tableUse this operation to view the highest peak values and highest average values for a protected IP range during a selected time period.
-
incap-get-ip-rangesUse this operation to get the updated list of Incapsula IP ranges.
-
incap-get-login-protectUse this operation to get the account's login protect user list.
-
incap-get-site-data-storage-regionUse this operation to get the site's data storage region.
-
incap-get-site-data-storage-region-geo-overrideUse this operation to check if the data storage region for each new site is based on the geolocation of the origin server.
-
incap-get-site-html-injection-rulesUse this operation to list all the HTML Injection rules.
-
incap-get-site-reportUse this operation to get a report for a site. Reports are sent using Base64 encoding.
-
incap-get-site-statusUse this operation to get the status of a site.
-
incap-get-statisticsUse this operation to get site statistics for one or more sites. This operation may return multiple statistics, as specified in the stats parameter.
-
incap-get-textsUse this operation to retrieve a list of all text messages that may be part of API responses.
-
incap-get-visitsUse this operation to get a log of recent visits to a website. The visits are fetched in reverse chronological order, starting with the most recent visit. Not all visits are recorded - only visits with abnormal activity are recorded e.g. violation of security rules, visits from black-listed IPs/Countries, etc. A visit may still be updated even after it was retrieved. To avoid retrieving such visits and to retrieve only visits that will no longer be updated use the list_live_visits parameter.
-
incap-list-managed-accountsUse this operation to get the list of accounts that are managed by account of the API client (the parent account).
-
incap-list-site-datacentersUse this operation to list a site's data centers including the data centers' servers.
-
incap-list-site-rule-revisionsUse this operation to list revisions of a rule (Delivery Rules or IncapRules).
-
incap-list-site-rulesUse this operation to list rules (Delivery Rules and IncapRules) for a given site.
-
incap-list-sitesList sites for an account.
-
incap-list-subaccountsUse this operation to get a list of sub accounts that are managed by the account of the API client (the parent account).
-
incap-modify-account-configurationUse this operation to change the configuration of the account of the API client or one of its managed accounts.
-
incap-modify-cache-modeUse this operation to edit basic site caching settings.
-
incap-modify-caching-rulesUse this operation to set-up advanced caching rules.
-
incap-modify-login-protectUse this operation to change Login Protect settings for site.
-
incap-modify-site-acl-configUse this operation to change the ACL configuration of a site. To modify the configuration for a specific ACL rule, its values are required, as documented below. To delete an entire ACL list, send an empty string as the list values.
-
incap-modify-site-configurationUse this operation to change one of the basic configuration settings of the site. To watch param table, visit https://my.incapsula.com/api/docs/v1/sites#modifySiteConfig
-
incap-modify-site-log-levelUse this operation to change the site log configuration.
-
incap-modify-site-scurity-configUse this operation to change the security configuration of a site.
-
incap-modify-site-tls-supportUse this operation to support all TLS versions for the site for connectivity between clients (visitors) and the Incapsula service. To remain PCI-compliant, do not enable this option.
-
incap-modify-site-wl-configUse this operation to set allow lists to security rules or ACLs. To update an existing allow list, send its ID in the id parameter. If the id parameter does not exist a new allow list will be created.
-
incap-move-siteUse this operation to move a site from one account to another. You can move a site from a master account to one of its sub accounts, or from one sub account to another.
-
incap-purge-hostname-from-cacheUse this operation to purge the hostname from the cache. This API is for customers who use the same CNAME provided by Incapsula 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.
-
incap-purge-resourcesUse this operation to purge site resources.
-
incap-purge-site-cacheUse 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.
-
incap-remove-custom-integrationUse this operation to remove custom certificate.
-
incap-remove-login-protectUse this operation to remove login protect user from account's user list.
-
incap-revert-site-ruleRevert a rule (Delivery Rule or IncapRule) using an existing revision.
-
incap-send-sms-to-userUse this operation to send SMS to login protect user.
-
incap-set-account-default-data-storage-regionUse this operation to set the default data region of the account for newly created sites.
-
incap-set-account-default-log-storageUse this operation to have your logs saved on Incapsula servers. Once configured, the logs can be retrieved by API calls.
-
incap-set-account-log-levelUse this operation to change the account log configuration.
-
incap-set-account-s3-log-storageUse this operation to configure your Amazon cloud storage. Once configured, Incapsula logs will be uploaded to the selected location.
-
incap-set-account-sftp-log-storageUse this operation to configure your SFTP server storage. Once configured, Incapsula logs will be uploaded to the selected location.
-
incap-set-advanced-caching-settingsUse this operation to modify advanced caching settings. For more information, https://my.incapsula.com/api/docs/v1/sites#modifyAdvancedCachingSettings
-
incap-set-site-data-storage-regionUse this operation to set the site's data storage region.
-
incap-set-site-data-storage-region-geo-overrideUse this operation to set the data storage region for each new site based on the geolocation of the origin server.
-
incap-set-site-rule-priorityUse this operation to change a Delivery Rule's priority.
-
incap-site-get-xray-linkUse this operation to get a URL that enables debug headers on a specific site.
-
incap-test-account-s3-connectionUse this operation to check that a connection can be created with your Amazon S3 bucket.
-
incap-test-account-sftp-connectionUse this operation to check that a connection can be created with your SFTP storage.
-
incap-upload-certificateUse this operation to upload custom certificate for your site. The following SSL certificate file formats are supported: PFX, PEM, CER.
-
incap-upload-public-keyOrganizations that purchased the Security Logs Integration SKU can download security events created for their account and archive or push those events into their SIEM solution.