Redact Configuration 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

• Redact Documentation
• OpenAPI Specification

post/v1beta/config

cURL

Code Snippet Language

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

Response

Raw Output

200

Code Snippet Language

Get redact config (Beta)

POST

https://redact.aws.us.pangea.cloud/v1beta/config

required parameters

id

string

An ID for a service config

​

Response Fields

Response Schema

object

Pangea standard response schema

result

version

string

(default: "1.0.0")

id

string

name

string

updated_at

string (date-time)

enabled_rules

array<string>

(default: )

redactions

object

Pattern Property: ^.*$

redaction_type

string

redaction_value

string

partial_masking

object

masking_type

string

(default: "unmask")

unmasked_from_left

integer

• minimum: 0

unmasked_from_right

integer

• minimum: 0

masked_from_left

integer

• minimum: 0

masked_from_right

integer

• minimum: 0

chars_to_ignore

array<string>

masking_char

string

(default: "*")

• minLength: 1

• maxLength: 1

hash

object, null

fpe_alphabet

fpe_tweak_vault_secret_id

string, null

fpe_tweak

string, null

• minLength: 7

• maxLength: 7

vault_service_config_id

string, null

Service config used to create the secret

salt_vault_secret_id

string, null

Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.

rules

object

Pattern Property: ^.*$

object

entity_name

string

matchers

ruleset

string

match_threshold

number

• minimum: 0.1

• maximum: 1

context_values

array,null<string>

name

string

description

string

rulesets

object

^.*$

object

name

string

description

string

supported_languages

array<string>

request_id

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"

request_time

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"

response_time

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"

status

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"

summary

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/v1beta/config/create

cURL

Code Snippet Language

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

This endpoint cannot be called through the documentation site

Create redact config (Beta)

POST

https://redact.aws.us.pangea.cloud/v1beta/config/create

Create a redact service config

required parameters

name

string

optional parameters

version

string

(default: "2.0.0")

Current version: 2.0.0

id

string

updated_at

string (date-time)

enabled_rules

array<string>

(default: )

enforce_enabled_rules

boolean

(default: false)

Always run service config enabled rules across all redact calls regardless of flags?

redactions

object

Pattern Property: ^.*$

redaction_type

string

redaction_value

string

partial_masking

object

masking_type

string

(default: "unmask")

unmasked_from_left

integer

• minimum: 0

unmasked_from_right

integer

• minimum: 0

masked_from_left

integer

• minimum: 0

masked_from_right

integer

• minimum: 0

chars_to_ignore

array<string>

masking_char

string

(default: "*")

• minLength: 1

• maxLength: 1

hash

object, null

fpe_alphabet

fpe_tweak_vault_secret_id

string, null

fpe_tweak

string, null

• minLength: 7

• maxLength: 7

vault_service_config_id

string, null

Service config used to create the secret

salt_vault_secret_id

string, null

Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.

fpe_vault_secret_id

string, null

The ID of the key used by FF3 Encryption algorithms for FPE.

rules

object

Pattern Property: ^.*$

object

entity_name

string

matchers

match_threshold

number

• minimum: 0.1

• maximum: 1

context_values

array,null<string>

negative_context_values

array,null<string>

name

string

description

string

rulesets

object

^.*$

object

name

string

description

string

rules

array<string>

supported_languages

array<string>

Response Fields

Response Schema

object

Pangea standard response schema

result

version

string

(default: "1.0.0")

id

string

name

string

updated_at

string (date-time)

enabled_rules

array<string>

(default: )

redactions

object

Pattern Property: ^.*$

redaction_type

string

redaction_value

string

partial_masking

object

masking_type

string

(default: "unmask")

unmasked_from_left

integer

• minimum: 0

unmasked_from_right

integer

• minimum: 0

masked_from_left

integer

• minimum: 0

masked_from_right

integer

• minimum: 0

chars_to_ignore

array<string>

masking_char

string

(default: "*")

• minLength: 1

• maxLength: 1

hash

object, null

fpe_alphabet

fpe_tweak_vault_secret_id

string, null

fpe_tweak

string, null

• minLength: 7

• maxLength: 7

vault_service_config_id

string, null

Service config used to create the secret

salt_vault_secret_id

string, null

Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.

rules

object

Pattern Property: ^.*$

object

entity_name

string

matchers

ruleset

string

match_threshold

number

• minimum: 0.1

• maximum: 1

context_values

array,null<string>

name

string

description

string

rulesets

object

^.*$

object

name

string

description

string

supported_languages

array<string>

request_id

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"

request_time

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"

response_time

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"

status

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"

summary

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/v1beta/config/update

cURL

Code Snippet Language

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

This endpoint cannot be called through the documentation site

Update redact config (Beta)

POST

https://redact.aws.us.pangea.cloud/v1beta/config/update

required parameters

id

string

name

string

updated_at

string (date-time)

optional parameters

version

string

(default: "2.0.0")

Current version: 2.0.0

enabled_rules

array<string>

(default: )

enforce_enabled_rules

boolean

(default: false)

Always run service config enabled rules across all redact calls regardless of flags?

redactions

object

Pattern Property: ^.*$

redaction_type

string

redaction_value

string

partial_masking

object

masking_type

string

(default: "unmask")

unmasked_from_left

integer

• minimum: 0

unmasked_from_right

integer

• minimum: 0

masked_from_left

integer

• minimum: 0

masked_from_right

integer

• minimum: 0

chars_to_ignore

array<string>

masking_char

string

(default: "*")

• minLength: 1

• maxLength: 1

hash

object, null

fpe_alphabet

fpe_tweak_vault_secret_id

string, null

fpe_tweak

string, null

• minLength: 7

• maxLength: 7

vault_service_config_id

string, null

Service config used to create the secret

salt_vault_secret_id

string, null

Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.

fpe_vault_secret_id

string, null

The ID of the key used by FF3 Encryption algorithms for FPE.

rules

object

Pattern Property: ^.*$

object

entity_name

string

matchers

match_threshold

number

• minimum: 0.1

• maximum: 1

context_values

array,null<string>

negative_context_values

array,null<string>

name

string

description

string

rulesets

object

^.*$

object

name

string

description

string

rules

array<string>

supported_languages

array<string>

Response Fields

Response Schema

object

Pangea standard response schema

result

version

string

(default: "1.0.0")

id

string

name

string

updated_at

string (date-time)

enabled_rules

array<string>

(default: )

redactions

object

Pattern Property: ^.*$

redaction_type

string

redaction_value

string

partial_masking

object

masking_type

string

(default: "unmask")

unmasked_from_left

integer

• minimum: 0

unmasked_from_right

integer

• minimum: 0

masked_from_left

integer

• minimum: 0

masked_from_right

integer

• minimum: 0

chars_to_ignore

array<string>

masking_char

string

(default: "*")

• minLength: 1

• maxLength: 1

hash

object, null

fpe_alphabet

fpe_tweak_vault_secret_id

string, null

fpe_tweak

string, null

• minLength: 7

• maxLength: 7

vault_service_config_id

string, null

Service config used to create the secret

salt_vault_secret_id

string, null

Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.

rules

object

Pattern Property: ^.*$

object

entity_name

string

matchers

ruleset

string

match_threshold

number

• minimum: 0.1

• maximum: 1

context_values

array,null<string>

name

string

description

string

rulesets

object

^.*$

object

name

string

description

string

supported_languages

array<string>

request_id

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"

request_time

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"

response_time

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"

status

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"

summary

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/v1beta/config/delete

cURL

Code Snippet Language

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

This endpoint cannot be called through the documentation site

Delete redact config (Beta)

POST

https://redact.aws.us.pangea.cloud/v1beta/config/delete

required parameters

id

string

An ID for a service config

Response Fields

Response Schema

object

Pangea standard response schema

result

version

string

(default: "1.0.0")

id

string

name

string

updated_at

string (date-time)

enabled_rules

array<string>

(default: )

redactions

object

Pattern Property: ^.*$

redaction_type

string

redaction_value

string

partial_masking

object

masking_type

string

(default: "unmask")

unmasked_from_left

integer

• minimum: 0

unmasked_from_right

integer

• minimum: 0

masked_from_left

integer

• minimum: 0

masked_from_right

integer

• minimum: 0

chars_to_ignore

array<string>

masking_char

string

(default: "*")

• minLength: 1

• maxLength: 1

hash

object, null

fpe_alphabet

fpe_tweak_vault_secret_id

string, null

fpe_tweak

string, null

• minLength: 7

• maxLength: 7

vault_service_config_id

string, null

Service config used to create the secret

salt_vault_secret_id

string, null

Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.

rules

object

Pattern Property: ^.*$

object

entity_name

string

matchers

ruleset

string

match_threshold

number

• minimum: 0.1

• maximum: 1

context_values

array,null<string>

name

string

description

string

rulesets

object

^.*$

object

name

string

description

string

supported_languages

array<string>

request_id

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"

request_time

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"

response_time

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"

status

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"

summary

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/v1beta/config/list

cURL

Code Snippet Language

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

Response

Raw Output

200

Code Snippet Language

List redact configs (Beta)

POST

https://redact.aws.us.pangea.cloud/v1beta/config/list

List redact service configs

fields

filter

object

id

string

Only records where id equals this value.

id

id

id__contains

array<string>

Only records where id includes each substring.

id__contains

id__contains

id__in

array<string>

Only records where id equals one of the provided substrings.

id__in

id__in

created_at

string (date-time)

Only records where created_at equals this value.

created_at

created_at

created_at__gt

string (date-time)

Only records where created_at is greater than this value.

created_at__gt

created_at__gt

created_at__gte

string (date-time)

Only records where created_at is greater than or equal to this value.

created_at__gte

created_at__gte

created_at__lt

string (date-time)

Only records where created_at is less than this value.

created_at__lt

created_at__lt

created_at__lte

string (date-time)

Only records where created_at is less than or equal to this value.

created_at__lte

created_at__lte

updated_at

string (date-time)

Only records where updated_at equals this value.

updated_at

updated_at

updated_at__gt

string (date-time)

Only records where updated_at is greater than this value.

updated_at__gt

updated_at__gt

updated_at__gte

string (date-time)

Only records where updated_at is greater than or equal to this value.

updated_at__gte

updated_at__gte

updated_at__lt

string (date-time)

Only records where updated_at is less than this value.

updated_at__lt

updated_at__lt

updated_at__lte

string (date-time)

Only records where updated_at is less than or equal to this value.

updated_at__lte

updated_at__lte

last

string

Reflected value from a previous response to obtain the next page of results.

last

last

order

string

Order results asc(ending) or desc(ending).

order

​

order

order_by

string

Which field to order results by.

order_by

​

order_by

size

integer

Maximum results to include in the response.

• minimum: 1

size

size

Response Fields

Response Schema

object

Pangea standard response schema

result

object

count

integer

The total number of service configs matched by the list request.

last

string

Used to fetch the next page of the current listing when provided in a repeated request's last parameter.

items

version

string

(default: "1.0.0")

id

string

name

string

updated_at

string (date-time)

enabled_rules

array<string>

(default: )

redactions

object

Pattern Property: ^.*$

redaction_type

string

redaction_value

string

partial_masking

object

masking_type

string

(default: "unmask")

unmasked_from_left

integer

• minimum: 0

unmasked_from_right

integer

• minimum: 0

masked_from_left

integer

• minimum: 0

masked_from_right

integer

• minimum: 0

chars_to_ignore

array<string>

masking_char

string

(default: "*")

• minLength: 1

• maxLength: 1

hash

object, null

fpe_alphabet

fpe_tweak_vault_secret_id

string, null

fpe_tweak

string, null

• minLength: 7

• maxLength: 7

vault_service_config_id

string, null

Service config used to create the secret

salt_vault_secret_id

string, null

Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.

rules

object

Pattern Property: ^.*$

object

entity_name

string

matchers

ruleset

string

match_threshold

number

• minimum: 0.1

• maximum: 1

context_values

array,null<string>

name

string

description

string

rulesets

object

^.*$

object

name

string

description

string

supported_languages

array<string>

request_id

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"

request_time

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"

response_time

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"

status

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"

summary

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.

Status Codes

Status	Status Code	Description
InvalidFPEKey	400	FPE key provided was not valid
RegexTimeout	400	A user-provided regex took too long to run

Was this article helpful?

Contact us