Imperva Site Management API
Add, remove, and update sites.
Imperva Site Management API is one of 15 APIs that Imperva publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Site Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 77 operations across 77 paths, and defines 47 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://my.imperva.com.
77 operations
77 paths
47 schemas
77 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Imperva Site Management API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-API-Id (api_id).
An API key is passed in the header as x-API-Key (api_key).
By default, every request must be authenticated.
Paths & Operations 77
Across 77 paths, the API surfaces 77 operations — 77 POST. Each is listed below with its method, path, parameters, and response codes.
Site Management 77
Add, remove, and update sites.
POST
/api/prov/v1/sites/performance/caching-rules/add
Add a cache rule
POST
/api/prov/v1/sites/performance/caching-rules/delete
Delete a cache rule
POST
/api/prov/v1/sites/performance/caching-rules/enable
Enable or disable cache rule
POST
/api/prov/v1/sites/performance/caching-rules/list
List cache rules for a given site
POST
/api/prov/v1/sites/performance/caching-rules/edit
Edit a cache rule
POST
/api/prov/v1/sites/dataCenters/add
Add data center
POST
/api/prov/v1/sites/dataCenters/edit
Edit site
POST
/api/prov/v1/sites/dataCenters/resume
Resume traffic to your active data centers
POST
/api/prov/v1/sites/dataCenters/delete
delete site
POST
/api/prov/v1/sites/dataCenters/servers/add
Add datacenter
POST
/api/prov/v1/sites/dataCenters/servers/delete
Delete datacenter
POST
/api/prov/v1/sites/dataCenters/servers/edit
Edit datacenter
POST
/api/prov/v1/sites/dataCenters/list
List site's data centers
POST
/api/prov/v1/sites/datacenter/origin-pop/modify
Set Data Center Origin PoP
POST
/api/prov/v1/sites/datacenter/origin-pop/recommend
Get Data Center Recommended Origin PoPs
POST
/api/prov/v1/sites/performance/cache-mode
Modify Caching Mode
POST
/api/prov/v1/sites/performance/cache-mode/get
Get Caching Mode
POST
/api/prov/v1/sites/performance/purge
Purge Resources
POST
/api/prov/v1/sites/cache/purge
Purge Site Cache
POST
/api/prov/v1/sites/performance/response-headers
Modify Cached Response Headers
POST
/api/prov/v1/sites/performance/response-headers/get
Get Cached Response Headers
POST
/api/prov/v1/sites/performance/tag-response
Tag the Response According to the Value of a Header
POST
/api/prov/v1/sites/performance/tag-response/get
Get Header to Tag Responses By
POST
/api/prov/v1/sites/performance/cache404/modify
Modify Cache 404 Settings
POST
/api/prov/v1/sites/performance/cache404
Get Cache 404 Settings
POST
/api/prov/v1/sites/performance/pop-level-cache/modify
Modify PoP Level Cache
POST
/api/prov/v1/sites/performance/pop-level-cache
Get PoP Level Cache
POST
/api/prov/v1/sites/performance/resource-map-size/modify
Set Resource Map Size
POST
/api/prov/v1/sites/performance/resource-map-size
Get Resource Map Size
POST
/api/prov/v1/sites/performance/cache-size-limit-large-mem/modify
Set Total Cache Size
POST
/api/prov/v1/sites/performance/cache-size-limit-large-mem
Get Total Cache Size
POST
/api/prov/v1/sites/performance/max-resp-size/modify
Set Response Max Size
POST
/api/prov/v1/sites/performance/max-resp-size
Get Response Max Size
POST
/api/prov/v1/sites/performance/secure-resources
Modify Secure Resources Mode
POST
/api/prov/v1/sites/performance/secure-resources/get
Get Secure Resources Mode
POST
/api/prov/v1/sites/performance/stale-content
Modify Stale Content Settings
POST
/api/prov/v1/sites/performance/stale-content/get
Get Stale Content Settings
POST
/api/prov/v1/sites/performance/advanced
Advanced Caching Settings
POST
/api/prov/v1/sites/performance/advanced/get
Get Advanced Caching Settings
POST
/api/prov/v1/sites/xray/get-link
Get XRay Access Link
POST
/api/prov/v1/sites/performance/cache-shield/enable
Enable Cache Shield
POST
/api/prov/v1/sites/performance/cache-shield
Is Cache Shield Enabled
POST
/api/prov/v1/sites/performance/rewrite-port/modify
Modify Rewrite Port
POST
/api/prov/v1/sites/performance/rewrite-port
Get Rewrite Port
POST
/api/prov/v1/sites/performance/error-page/modify
Modify Error Page
POST
/api/prov/v1/sites/performance/error-page
Get Error Page
POST
/api/prov/v1/sites/status
Get Site Status
POST
/api/prov/v1/sites/list
List Sites
POST
/api/prov/v1/domain/emails
Get Domain Approver E-mail Addresses
POST
/api/prov/v1/sites/setlog
Modify Site Logs Level
POST
/api/prov/v1/sites/tls
Set support for all TLS versions
POST
/api/prov/v1/sites/configure
Modify Site Configuration
POST
/api/prov/v1/sites/delete
Delete Site
POST
/api/prov/v1/sites/add
Add a Site
POST
/api/prov/v1/sites/configure/acl
Modify Site Access Control List (ACL) Configuration
POST
/api/prov/v1/sites/data-privacy/show
Get Site Data Storage Region
POST
/api/prov/v1/sites/configure/allowlist
Modify Allow Lists Configuration
POST
/api/prov/v1/sites/configure/security
Modify Site Security Configuration
POST
/api/prov/v1/sites/report
Get Site Report
POST
/api/prov/v1/sites/hostname/purge
Purge Hostname from Cache
POST
/api/prov/v1/sites/htmlinjections
Get HTML Injection Rules
POST
/api/prov/v1/sites/configure/htmlInjections
Add, Replace or Remove a HTML Injection Rule
POST
/api/prov/v1/sites/customCertificate/upload
Upload Custom Certificate
POST
/api/prov/v1/sites/customCertificate/remove
Remove Custom Certificate
POST
/api/prov/v1/sites/customCertificate/csr
Create New CSR
POST
/api/prov/v1/sites/data-privacy/region-change
Set Site Data Storage Region
POST
/api/prov/v1/sites/data-privacy/show-override-by-geo
List Available PoPs for Denylist/Allowlist
POST
/api/prov/v1/sites/data-privacy/override-by-geo
Set Site Regions by Origin Geolocation
POST
/api/prov/v1/caa/check-compliance
Check CAA compliance
POST
/api/prov/v1/sites/moveSite
Move site
POST
/api/prov/v1/sites/incapRules/priority/set
Set Rule Priority
POST
/api/prov/v1/sites/incapRules/edit
Edit Rule
POST
/api/prov/v1/sites/incapRules/add
Add Rule
POST
/api/prov/v1/sites/incapRules/enableDisable
Enable or Disable Rule
POST
/api/prov/v1/sites/incapRules/delete
Delete Data Center
POST
/api/prov/v1/sites/incapRules/list
List Rules
POST
/api/prov/v1/sites/incapRules/account/list
List Account Rules
Schemas 47
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are ApiResultSiteStatus (29 properties), PerformanceConfigurationApiResult (21 properties), SiteDualFactorSettings (10 properties), IncapRuleApiResult (8 properties). Each schema is shown below with its type and property counts.
ApiResultGetResponseHeaderSettings
object
6 properties
PerformanceConfigurationApiResult
object
21 properties
ListCustomRulesResponse
object
3 properties
ApiResult
object
3 properties
DnsInstructionItem
object
3 properties
specific_users_list
object
3 properties
ApiResultReport
object
5 properties
IncapRuleApiResult
object
8 properties
ApiResultAddCacheRule
object
4 properties
GetPopLevelCacheSettingsApiResult
object
4 properties
ApiResultHtmlInjections
object
4 properties
CaaComplianceCheckResult
object
3 properties
RewritePort
object
2 properties
HtmlInjectionItem
object
4 properties
ApiResultGetCacheMode
object
4 properties
ApiResultDomainEmails
object
4 properties
SiteConfigurationWarning
object
2 properties
ApiResultGetRewritePorts
object
5 properties
IsCacheShieldEnabledApiResult
object
4 properties
customAreasExceptions
object
2 properties
ServerOperationResponse
object
3 properties
ApiResultGetSiteXrayLink
object
4 properties
ApiResultGetSecureResources
object
4 properties
SetPriorityResponse
object
2 properties
SiteCacheRuleResponse
object
LoginProtectApiResult
object
7 properties
RecommendedPopsApiResult
object
5 properties
PopRttResponse
object
4 properties
ApiResultGetTagResponseHeader
object
4 properties
ListDataCenterResponse
object
DeleteCustomRuleResponse
object
2 properties
customAreas
object
2 properties
ApiResultMoveSite
object
4 properties
ApiResultSiteStatus
object
29 properties
ApiResultGetResourceMapSize
object
4 properties
CustomRuleResponse
object
3 properties
GetAdvancedCachingSettingsApiResult
object
4 properties
ApiResultGetCacheSizeLimitLargeMem
object
5 properties
GetCache404SettingsApiResult
object
6 properties
ApiResultGetMaxRespSize
object
5 properties
DataCenterResponse
object
3 properties
ApiResultSetDataRegion
object
4 properties
ApiResultListSites
object
4 properties
ApiResultSetSupportDeprecatedTLSForSite
object
6 properties
SiteDualFactorSettings
object
10 properties
APISealLocationItem
object
2 properties
GetStaleContentApiResult
object
7 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Imperva 12
Other APIs Imperva publishes across the network.
Imperva API Security
Imperva Data Security Fabric API
Imperva Account Management API
Imperva Administration API
Imperva Auth API
Imperva Conf API
Imperva DDoS for Networks Test Alerts API
Imperva DDoS Protection for Individual IPs API
Imperva Experimental API
Imperva Integrations API
Imperva Login Protect API
Imperva Management API
#Site Management