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 Login Protect API

Provision Login Protect users and configure protected pages.

Imperva Login Protect API is one of 15 APIs that Imperva publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Login Protect. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

7 operations 7 paths 14 schemas 7 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 Login Protect 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 7

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

Login Protect 7

Provision Login Protect users and configure protected pages.

POST
/api/prov/v1/sites/lp/configure
Add Login Protect User
modifyLpSiteConfiguration 8 params → 200
POST
/api/prov/v1/sites/lp/configure-app
Configure Login Protect on Admin Areas
configureProtectedAppByLp 2 params → 200
POST
/api/prov/v1/sites/lp/add-user
Add Login Protect User
addLpUser 7 params → 200
POST
/api/prov/v1/sites/lp/users
Get Login Protect Users
getLpUsers 1 param → 200
POST
/api/prov/v1/sites/lp/edit-user
Edit Login Protect User
editLpUser 7 params → 200
POST
/api/prov/v1/sites/lp/send-sms
Send SMS to User
sendSms 3 params → 200
POST
/api/prov/v1/sites/lp/remove
Remove Login Protect User
removeLpUser 2 params → 200

Schemas 14

The contract defines 14 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.

APISealLocationItem
object
2 properties
ApiResultSiteStatus
object
29 properties
LoginProtectApiResult
object
7 properties
PerformanceConfigurationApiResult
object
21 properties
ApiResult
object
3 properties
DnsInstructionItem
object
3 properties
specific_users_list
object
3 properties
SiteConfigurationWarning
object
2 properties
LoginProtectUsersApiResults
object
1 property
customAreasExceptions
object
2 properties
SiteDualFactorSettings
object
10 properties
IncapRuleApiResult
object
8 properties
customAreas
object
2 properties
LpExtendedUser
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

imperva-login-protect-api-openapi.yml Raw ↑

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