Modify PII settings for an endpoint version

post

https://{hostname}/api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/settings

Update the PII settings in an endpoint version. These settings are for a PII object per endpoint version, so if you have the same object in multiple endpoint versions, you'll need to run the operation for each version. This includes parameters with PII already in your API definition, as well as parameters with PII the network discovers on your behalf. You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. Run Enable PII learning settings for a configuration to use this feature.

Path Params

apiEndPointId

integer

required

The unique identifier for the endpoint.

versionNumber

integer

required

The unique identifier for the endpoint version.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Describes the full PII object.

constraints

object

required

Describes how and where to look for personally identifiable information (PII) in your API payloads.

exclusions

array of objects

required

Parameters you want to exclude from inspecting and enforcing constraints.

exclusions*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Successfully updated the endpoint version.

403Forbidden. You don't have permission to update PII settings.