Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Imperva Account Management API

Add, delete, and modify accounts. Get account details.

Imperva Account 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 Account Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 16 paths, and defines 13 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.

16 operations 16 paths 13 schemas 16 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.imperva.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Imperva Account 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 16

Across 16 paths, the API surfaces 16 operations — 16 POST. Each is listed below with its method, path, parameters, and response codes.

Account Management 16

Add, delete, and modify accounts. Get account details.

POST
/api/prov/v1/accounts/gettoken
Get account login token
getToken 2 params → 200
POST
/api/prov/v1/accounts/list
List managed accounts
listAccounts 3 params → 200
POST
/api/prov/v1/subaccounts/add
Add a new sub account
addSubAccount 5 params → 200
POST
/api/prov/v1/accounts/listSubAccounts
List account's sub accounts
listSubAccounts 3 params → 200
POST
/api/prov/v1/accounts/configure
Modify account configuration
modifyAccountConfiguration 3 params → 200
POST
/api/prov/v1/accounts/delete
Delete managed account
deleteAccount 1 param → 200
POST
/api/prov/v1/subaccounts/delete
Delete sub account
deleteSubAccount 1 param → 200
POST
/api/prov/v1/accounts
Get account status
getAccountStatus 1 param → 200
POST
/api/prov/v1/accounts/setlog
Modify account log level
modifyAccountLogLevel 2 params → 200
POST
/api/prov/v1/accounts/subscription
Get account subscription details
subscription 1 param → 200
POST
/api/prov/v1/accounts/add
Add a new managed account
addAccount 10 params → 200
POST
/api/prov/v1/accounts/testS3Connection
Test connection with S3 bucket
testConnectionS3 5 params → 200
POST
/api/prov/v1/accounts/testSftpConnection
Test connection with SFTP server
testConnectionSftp 6 params → 200
POST
/api/prov/v1/accounts/setDefaultSiemStorage
Set Imperva servers for log storage
setDefaultSiemStorage 1 param → 200
POST
/api/prov/v1/accounts/setAmazonSiemStorage
Set S3 configuration for log storage
setStorageToS3 4 params → 200
POST
/api/prov/v1/accounts/setSftpSiemStorage
Set SFTP server configuration for log storage
setStorageToSftp 5 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are accounts (13 properties), account (13 properties), SubAccountStatus (6 properties), AccountPlanStatus (6 properties). Each schema is shown below with its type and property counts.

ApiResult
object
3 properties
AccountBandwidth
object
3 properties
SubAccountStatus
object
6 properties
accounts
object
13 properties
Login
object
2 properties
account
object
13 properties
ApiResultAccountStatus
object
4 properties
ApiResultGetSsoToken
object
4 properties
ApiResultListUsers
object
4 properties
PlanSectionRow
object
3 properties
ApiResultAccountSubscription
object
5 properties
ApiResultSubAccountStatus
object
4 properties
AccountPlanStatus
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

imperva-account-management-api-openapi.yml Raw ↑

Other APIs Imperva publishes across the network.

Imperva API Security
Imperva Data Security Fabric 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
Imperva Site Management API