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

APIs.io Engineering Platform DLP Settings API

The DLP Settings API from APIs.io Engineering Platform — 3 operation(s) for dlp settings.

This API exposes 4 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

4 operations 3 paths 9 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform DLP Settings API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

DLP Settings 4
GET
/accounts/{account_id}/dlp/limits
APIs.io Engineering Platform Fetch limits associated with DLP for account
dlp-limits-get 1 param → 4XX200
POST
/accounts/{account_id}/dlp/patterns/validate
APIs.io Engineering Platform Validate a DLP regex pattern
dlp-pattern-validate 1 param body → 4XX200
GET
/accounts/{account_id}/dlp/payload_log
APIs.io Engineering Platform Get payload log settings
dlp-payload-log-get 1 param → 4XX200
PUT
/accounts/{account_id}/dlp/payload_log
APIs.io Engineering Platform Set payload log settings
dlp-payload-log-put 1 param body → 4XX200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are dlp_api-response-common-failure (4 properties), dlp_api-response-common (3 properties), dlp_PayloadLogSetting (2 properties), dlp_RegexValidationQuery (2 properties). Each schema is shown below with its type and property counts.

dlp_api-response-single
object
dlp_api-response-common
object
3 properties 3 required
dlp_RegexValidationResult
object
1 property 1 required
dlp_api-response-common-failure
object
4 properties 4 required
dlp_Limits
object
1 property 1 required
dlp_messages
array
dlp_PayloadLogSettingUpdate
object
1 property
dlp_PayloadLogSetting
object
2 properties 1 required
dlp_RegexValidationQuery
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-dlp-settings-api-openapi.yml Raw ↑