Imperva Conf API
The Conf API from Imperva — 126 operation(s) for conf.
The Conf API from Imperva — 126 operation(s) for conf.
openapi: 3.0.1
info:
title: Cloud Application Security Account Management Conf API
license:
name: Imperva License Agreement.
url: http://www.imperva.com/other/license_agreement.asp
version: '1.0'
description: Add, delete, and modify accounts. Get account details.
servers:
- url: https://my.imperva.com
description: Imperva API server
variables: {}
security:
- api_key: []
- api_id: []
tags:
- name: Conf
paths:
/v1/conf/webServices/{siteName}/{serverGroupName}/{webServiceName}:
put:
operationId: updateWebService
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/WebServiceDetailsDTO'
post:
operationId: createWebService
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/WebServiceDTO'
delete:
operationId: deleteWebService
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
get:
operationId: getWebServiceDetails
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/WebServiceDetailsDTO'
/v1/conf/dbServices/{siteName}/{serverGroupName}:
get:
operationId: getAllServices
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/ServicesDTO'
/v1/conf/tags/{tagName}/taggedObjects:
post:
operationId: tagObjects
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: tagName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/TaggedItemsDTO'
delete:
operationId: unTagObjects
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: tagName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/TaggedItemsDTO'
get:
operationId: getTagObjects
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: tagName
in: path
required: true
schema:
type: string
description: ''
- name: purpose
in: query
required: false
schema:
type: string
description: ''
- name: type
in: query
required: false
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/TaggedItemsDTO'
/v1/conf/gateways/{gatewayName}/reverseProxy/aliases:
get:
operationId: getAllKrpAliases
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: gatewayName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/KrpAliasesDTO'
/v1/conf/dataSets/{dataSetName}/data:
put:
operationId: incrementalOperationsOnDataset
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: dataSetName
in: path
required: true
schema:
type: string
description: ''
- name: overwrite
in: query
required: false
schema:
type: boolean
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/DatasetRecordsActionDTO'
post:
operationId: updateDatasetRecords
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: dataSetName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/DatasetRecordsDTO'
delete:
operationId: deleteAllDatasetRecords
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: dataSetName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
get:
operationId: getDatasetRecords
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: dataSetName
in: path
required: true
schema:
type: string
description: ''
- name: from
in: query
required: false
schema:
type: integer
description: ''
- name: to
in: query
required: false
schema:
type: integer
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/DatasetRecordsOutputDTO'
/v1/conf/webProfile/{siteName}/{serverGroupName}/{webServiceName}/{webApplicationName}/directories:
put:
operationId: setDirectoriesLock
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
- name: webApplicationName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
items:
$ref: '#/definitions/WebProfileDirectoryDTO'
type: array
get:
operationId: getDirectoriesLock
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
- name: webApplicationName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
items:
$ref: '#/definitions/WebProfileDirectoryDTO'
type: array
/v1/conf/dbApplications/{siteName}/{serverGroupName}/{dbServiceName}/{dbApplicationName}/dbSecurityPolicies:
get:
operationId: getDBSecurityPoliciesAppliedToApplication
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: dbServiceName
in: path
required: true
schema:
type: string
description: ''
- name: dbApplicationName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/DBSecurityPoliciesDTO'
/v1/conf/applicationGroups/{applicationGroupName}/auditPolicies:
get:
operationId: getAuditPoliciesAppliedToApplicationGroup
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: applicationGroupName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/AuditPoliciesDTO'
/v1/conf/webServices/{siteName}/{serverGroupName}/{webServiceName}/trpRules/{serverIp}/{listenerPortList}:
put:
operationId: updateTrpRule
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
- name: serverIp
in: path
required: true
schema:
type: string
description: ''
- name: listenerPortList
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/TransparentReverseProxyConfigurationDTO'
post:
operationId: createTrpRule
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
- name: serverIp
in: path
required: true
schema:
type: string
description: ''
- name: listenerPortList
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/TransparentReverseProxyConfigurationDTO'
delete:
operationId: deleteTrpRule
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
- name: serverIp
in: path
required: true
schema:
type: string
description: ''
- name: listenerPortList
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
get:
operationId: getTrpRule
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
- name: serverIp
in: path
required: true
schema:
type: string
description: ''
- name: listenerPortList
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/TransparentReverseProxyConfigurationDTO'
/v1/conf/dbServices/{siteName}/{serverGroupName}/{serviceName}/logCollectors:
post:
operationId: createLogCollector
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: serviceName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/LogCollectorDTO'
get:
operationId: getLogCollectorsByService
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: serviceName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/LogCollectorsDTO'
/v1/conf/dbSecurityPolicies:
get:
operationId: getAllDBSecurityPolicies
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: apply-level
in: query
required: false
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/DBSecurityPoliciesDTO'
/v1/conf/dbServices/{siteName}/{serverGroupName}/{serviceName}/logCollectors/{logCollectorName}:
put:
operationId: updateLogCollector
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: serviceName
in: path
required: true
schema:
type: string
description: ''
- name: logCollectorName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/LogCollectorDTO'
delete:
operationId: deleteLogCollector
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: serviceName
in: path
required: true
schema:
type: string
description: ''
- name: logCollectorName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
get:
operationId: getLogCollectorByName
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: serviceName
in: path
required: true
schema:
type: string
description: ''
- name: logCollectorName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/LogCollectorDTO'
/v1/conf/dataSets/createDataset:
post:
operationId: createDataset
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: caseSensitive
in: query
required: false
schema:
type: boolean
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/DatasetColumnsDTO'
/v1/conf/webServices/{siteName}/{serverGroupName}/{webServiceName}/sslCertificates/{sslKeyName}:
post:
operationId: uploadCertificate
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
- name: sslKeyName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/UploadCertificateDTO'
delete:
operationId: removeCertificate
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
- name: sslKeyName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
get:
operationId: getCertificate
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: webServiceName
in: path
required: true
schema:
type: string
description: ''
- name: sslKeyName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/CertificateDTO'
/v1/conf/dbServices/{siteName}/{serverGroupName}/{dbServiceName}/agents/{agentName}/dataInterfaces/{dataInterfaceID}:
post:
operationId: applyDataInterfaceToService
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: dbServiceName
in: path
required: true
schema:
type: string
description: ''
- name: agentName
in: path
required: true
schema:
type: string
description: ''
- name: dataInterfaceID
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
delete:
operationId: unapplyDataInterfaceToService
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
- name: dbServiceName
in: path
required: true
schema:
type: string
description: ''
- name: agentName
in: path
required: true
schema:
type: string
description: ''
- name: dataInterfaceID
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
/v1/conf/agents/{agentName}/dataInterfaces:
get:
operationId: getAllDataInterfaces
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: agentName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/DataInterfacesDTO'
/v1/conf/policies/security/webApplicationCustomPolicies:
get:
operationId: getAllPolicies
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/CustomWebPoliciesDTO'
/v1/conf/dasAssessment/scans:
post:
operationId: scans
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
responses:
default:
description: successful operation
/v1/conf/applicationGroups/{parentApplicationGroupName}/applicationGroups/{childApplicationGroupName}:
post:
operationId: createApplicationGroup
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: parentApplicationGroupName
in: path
required: true
schema:
type: string
description: ''
- name: childApplicationGroupName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
/v1/conf/dasAssessment/scanRecords:
post:
operationId: scanRecords
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/DasAssessmentRecordsFilterDTO'
/v1/conf/serverGroups/{siteName}/{serverGroupName}:
put:
operationId: updateServerGroup
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/ServerGroupDTO'
post:
operationId: createServerGroup
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
delete:
operationId: deleteServerGroup
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
responses:
default:
description: successful operation
get:
operationId: getServerGroup
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/ServerGroupDTO'
/v1/conf/applicationGroups/{applicationGroupName}/dbSecurityPolicies:
get:
operationId: getDBSecurityPoliciesAppliedToApplicationGroup
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: applicationGroupName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/definitions/DBSecurityPoliciesDTO'
/v1/conf/serverGroups/{siteName}/{serverGroupName}/protectedIPs:
get:
operationId: getProtectedIPs
summary: ''
description: ''
tags:
- Conf
security:
- basicAuth: []
parameters:
- name: siteName
in: path
required: true
schema:
type: string
description: ''
- name: serverGroupName
in: path
required: true
schema:
type: string
description: ''
responses:
'200':
description: successful operation
content:
application/json:
sc
# --- truncated at 32 KB (161 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/imperva/refs/heads/main/openapi/imperva-conf-api-openapi.yml