Skip to main content

Redact API Reference

The Pangea Redact API helps developers limit the sprawl of sensitive information by performing redaction using defined rules.

Base URL

redact.<csp>.<region>.pangea.cloud

post/v1/redact
curl -sSLX POST 'https://redact.aws.us.pangea.cloud/v1/redact' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Redact

POST
https://redact.aws.us.pangea.cloud/v1/redact

Redact sensitive information from provided text.

required parameters

string

The text data to redact

string

Config ID. Can be found at the top of the Redact dashboard.

boolean

Setting this value to false will omit the redacted result only returning count

boolean
(default: false)

Setting this value to true will provide a detailed analysis of the redacted data and the rules that caused redaction

array<string>

An array of redact rule short names

array<string>

An array of redact ruleset short names

object

Pangea standard response schema

object
string

The redacted text

integer

Number of redactions present in the text

object

Describes the decision process for redactions

object
integer
array<object>

The scoring result of a rule

string

The entity name

number

The certainty score that the entity matches this specific snippet

string

The text snippet that matched

integer

The starting index of a snippet

integer

The ending index of a snippet

boolean

Indicates if this rule was used to anonymize a text snippet

string, null

If this result relates to a specific structured text field, the key pointing to this text will be provided

object, null

Context information If context was applied to score

object, null

Context information If negative context was applied to score

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1/redact_structured
curl -sSLX POST 'https://redact.aws.us.pangea.cloud/v1/redact_structured' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Redact structured

POST
https://redact.aws.us.pangea.cloud/v1/redact_structured

Redact sensitive information from structured data (e.g., JSON).

required parameters

Structured data to redact

string

Config ID. Can be found at the top of the Redact dashboard.

array<string>

JSON path(s) used to identify the specific JSON fields to redact in the structured data. Note: If jsonp parameter is used, the data parameter must be in JSON format.

string
(default: "json")

The format of the structured data to redact

boolean

Setting this value to false will omit the redacted result only returning count

boolean
(default: false)

Setting this value to true will provide a detailed analysis of the redacted data and the rules that caused redaction

array<string>

An array of redact rule short names

array<string>

An array of redact ruleset short names

object

Pangea standard response schema

object

The redacted data

integer

Number of redactions present in the data

object

Describes the decision process for redactions

object
integer
array<object>

The scoring result of a rule

string

The entity name

number

The certainty score that the entity matches this specific snippet

string

The text snippet that matched

integer

The starting index of a snippet

integer

The ending index of a snippet

boolean

Indicates if this rule was used to anonymize a text snippet

string, null

If this result relates to a specific structured text field, the key pointing to this text will be provided

object, null

Context information If context was applied to score

object, null

Context information If negative context was applied to score

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Was this article helpful?

Contact us