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
curl -sSLX POST 'https://redact.aws.us.pangea.cloud/v1/redact' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
Redact
Redact sensitive information from provided text.
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
This field allows users to specify the redaction method per rule and its various parameters.
For example:
{
"EMAIL_ADDRESS": {
"redaction_type": "fpe",
"fpe_alphabet": "alphanumeric",
"fpe_tweak": "U05wczz"
}
}
object
string (pangea-id)
A vault key ID of an exportable key used to redact with FPE instead of using the service config default.
string (pangea-id)
A vault secret ID of a secret used to salt a hash instead of using the service config default.
boolean
(default: false)Is this redact call going to be used in an LLM request?
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 (base64)
If an FPE redaction method returned results, this will be the context passed to unredact.
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.