Prompt Guard Config Management API Reference

Base URL

prompt-guard.<csp>.<region>.pangea.cloud

• Prompt Guard Documentation
• OpenAPI Specification

post/v1beta/config

cURL

Code Snippet Language

curl -sSLX POST 'https://prompt-guard.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 Prompt Guard config

POST

https://prompt-guard.aws.us.pangea.cloud/v1beta/config

Retrieve a Prompt Guard service configuration by its ID.

required parameters

id

string

ID of a Prompt Guard service configuration

id

id

ID of a Prompt Guard service configuration

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

Configuration used by the Prompt Guard service

Configuration used by the Prompt Guard service

id

string

ID of a Prompt Guard service configuration

ID of a Prompt Guard service configuration

name

string

Human-readable name of the Prompt Guard service configuration

Human-readable name of the Prompt Guard service configuration

updated_at

string (date-time)

Database timestamp when the configuration was last updated. Automatically assigned.

Database timestamp when the configuration was last updated. Automatically assigned.

version

string

(default: "v1")

Version tag for the configuration, useful for tracking changes

Version tag for the configuration, useful for tracking changes

analyzers

object

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

malicious_detection_threshold

number

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

benign_detection_threshold

number, null

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

audit_data_activity

object

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

enabled

boolean

Whether activity logging is enabled for this configuration

Whether activity logging is enabled for this configuration

audit_service_config_id

string

ID of the Secure Audit Log service configuration where activity events should be recorded

ID of the Secure Audit Log service configuration where activity events should be recorded

areas

object

Specifies which types of Prompt Guard events should be logged

Specifies which types of Prompt Guard events should be logged

malicious_prompt

boolean

Logs requests that Prompt Guard identifies as malicious or risky

Logs requests that Prompt Guard identifies as malicious or risky

benign_prompt

boolean

Logs requests that Prompt Guard identifies as benign

Logs requests that Prompt Guard identifies as benign

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"

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"

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"

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"

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.

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://prompt-guard.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 Prompt Guard config

POST

https://prompt-guard.aws.us.pangea.cloud/v1beta/config/create

Create a new Prompt Guard service configuration.

fields

name

string

Human-readable name of the Prompt Guard service configuration

Human-readable name of the Prompt Guard service configuration

analyzers

object

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

malicious_detection_threshold

number

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

benign_detection_threshold

number, null

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

audit_data_activity

object

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

enabled

boolean

Whether activity logging is enabled for this configuration

Whether activity logging is enabled for this configuration

audit_service_config_id

string

ID of the Secure Audit Log service configuration where activity events should be recorded

ID of the Secure Audit Log service configuration where activity events should be recorded

areas

object

Specifies which types of Prompt Guard events should be logged

Specifies which types of Prompt Guard events should be logged

malicious_prompt

boolean

Logs requests that Prompt Guard identifies as malicious or risky

Logs requests that Prompt Guard identifies as malicious or risky

benign_prompt

boolean

Logs requests that Prompt Guard identifies as benign

Logs requests that Prompt Guard identifies as benign

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

Configuration used by the Prompt Guard service

Configuration used by the Prompt Guard service

id

string

ID of a Prompt Guard service configuration

ID of a Prompt Guard service configuration

name

string

Human-readable name of the Prompt Guard service configuration

Human-readable name of the Prompt Guard service configuration

updated_at

string (date-time)

Database timestamp when the configuration was last updated. Automatically assigned.

Database timestamp when the configuration was last updated. Automatically assigned.

version

string

(default: "v1")

Version tag for the configuration, useful for tracking changes

Version tag for the configuration, useful for tracking changes

analyzers

object

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

malicious_detection_threshold

number

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

benign_detection_threshold

number, null

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

audit_data_activity

object

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

enabled

boolean

Whether activity logging is enabled for this configuration

Whether activity logging is enabled for this configuration

audit_service_config_id

string

ID of the Secure Audit Log service configuration where activity events should be recorded

ID of the Secure Audit Log service configuration where activity events should be recorded

areas

object

Specifies which types of Prompt Guard events should be logged

Specifies which types of Prompt Guard events should be logged

malicious_prompt

boolean

Logs requests that Prompt Guard identifies as malicious or risky

Logs requests that Prompt Guard identifies as malicious or risky

benign_prompt

boolean

Logs requests that Prompt Guard identifies as benign

Logs requests that Prompt Guard identifies as benign

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"

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"

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"

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"

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.

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://prompt-guard.aws.us.pangea.cloud/v1beta/config/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

Update Prompt Guard config

POST

https://prompt-guard.aws.us.pangea.cloud/v1beta/config/update

Update a Prompt Guard service configuration.

To update a configuration, first retrieve the current version, apply your changes, and submit the updated configuration to this endpoint.

For a full example using a Project Admin management client, see the Service Configuration APIs documentation.

Configurations must be updated using the latest configuration timestamp.

To update your configuration fetch the latest configuration.

required parameters

id

string

ID of a Prompt Guard service configuration

id

id

ID of a Prompt Guard service configuration

name

string

Human-readable name of the Prompt Guard service configuration

name

name

Human-readable name of the Prompt Guard service configuration

updated_at

string (date-time)

Database timestamp when the configuration was last updated. Automatically assigned.

updated_at

updated_at

Database timestamp when the configuration was last updated. Automatically assigned.

optional parameters

version

string

(default: "v1")

Version tag for the configuration, useful for tracking changes

​

Version tag for the configuration, useful for tracking changes

analyzers

object

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

Click 'Save' to use the value

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

malicious_detection_threshold

number

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

malicious_detection_threshold

malicious_detection_threshold

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

benign_detection_threshold

number, null

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

benign_detection_threshold

benign_detection_threshold

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

audit_data_activity

object

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

enabled

boolean

Whether activity logging is enabled for this configuration

enabled

​

enabled

Whether activity logging is enabled for this configuration

audit_service_config_id

string

ID of the Secure Audit Log service configuration where activity events should be recorded

audit_service_config_id

audit_service_config_id

ID of the Secure Audit Log service configuration where activity events should be recorded

areas

object

Specifies which types of Prompt Guard events should be logged

Specifies which types of Prompt Guard events should be logged

malicious_prompt

boolean

Logs requests that Prompt Guard identifies as malicious or risky

malicious_prompt

​

malicious_prompt

Logs requests that Prompt Guard identifies as malicious or risky

benign_prompt

boolean

Logs requests that Prompt Guard identifies as benign

benign_prompt

​

benign_prompt

Logs requests that Prompt Guard identifies as benign

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

Configuration used by the Prompt Guard service

Configuration used by the Prompt Guard service

id

string

ID of a Prompt Guard service configuration

ID of a Prompt Guard service configuration

name

string

Human-readable name of the Prompt Guard service configuration

Human-readable name of the Prompt Guard service configuration

updated_at

string (date-time)

Database timestamp when the configuration was last updated. Automatically assigned.

Database timestamp when the configuration was last updated. Automatically assigned.

version

string

(default: "v1")

Version tag for the configuration, useful for tracking changes

Version tag for the configuration, useful for tracking changes

analyzers

object

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

malicious_detection_threshold

number

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

benign_detection_threshold

number, null

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

audit_data_activity

object

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

enabled

boolean

Whether activity logging is enabled for this configuration

Whether activity logging is enabled for this configuration

audit_service_config_id

string

ID of the Secure Audit Log service configuration where activity events should be recorded

ID of the Secure Audit Log service configuration where activity events should be recorded

areas

object

Specifies which types of Prompt Guard events should be logged

Specifies which types of Prompt Guard events should be logged

malicious_prompt

boolean

Logs requests that Prompt Guard identifies as malicious or risky

Logs requests that Prompt Guard identifies as malicious or risky

benign_prompt

boolean

Logs requests that Prompt Guard identifies as benign

Logs requests that Prompt Guard identifies as benign

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"

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"

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"

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"

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.

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://prompt-guard.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 Prompt Guard config

POST

https://prompt-guard.aws.us.pangea.cloud/v1beta/config/delete

Delete an Prompt Guard service configuration.

required parameters

id

string

ID of a Prompt Guard service configuration

ID of a Prompt Guard service configuration

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

Configuration used by the Prompt Guard service

Configuration used by the Prompt Guard service

id

string

ID of a Prompt Guard service configuration

ID of a Prompt Guard service configuration

name

string

Human-readable name of the Prompt Guard service configuration

Human-readable name of the Prompt Guard service configuration

updated_at

string (date-time)

Database timestamp when the configuration was last updated. Automatically assigned.

Database timestamp when the configuration was last updated. Automatically assigned.

version

string

(default: "v1")

Version tag for the configuration, useful for tracking changes

Version tag for the configuration, useful for tracking changes

analyzers

object

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

malicious_detection_threshold

number

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

benign_detection_threshold

number, null

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

audit_data_activity

object

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

enabled

boolean

Whether activity logging is enabled for this configuration

Whether activity logging is enabled for this configuration

audit_service_config_id

string

ID of the Secure Audit Log service configuration where activity events should be recorded

ID of the Secure Audit Log service configuration where activity events should be recorded

areas

object

Specifies which types of Prompt Guard events should be logged

Specifies which types of Prompt Guard events should be logged

malicious_prompt

boolean

Logs requests that Prompt Guard identifies as malicious or risky

Logs requests that Prompt Guard identifies as malicious or risky

benign_prompt

boolean

Logs requests that Prompt Guard identifies as benign

Logs requests that Prompt Guard identifies as benign

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"

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"

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"

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"

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.

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://prompt-guard.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 Prompt Guard configs

POST

https://prompt-guard.aws.us.pangea.cloud/v1beta/config/list

Retrieve a paginated list of Prompt Guard service configurations.

fields

filter

object

id

string

Only records where id equals this value.

id

id

Only records where id equals this value.

id__contains

array<string>

Only records where id includes each substring.

Click 'Save' to use the value

Only records where id includes each substring.

id__in

array<string>

Only records where id equals one of the provided substrings.

Click 'Save' to use the value

Only records where id equals one of the provided substrings.

created_at

string (date-time)

Only records where created_at equals this value.

created_at

created_at

Only records where created_at equals this value.

created_at__gt

string (date-time)

Only records where created_at is greater than this value.

created_at__gt

created_at__gt

Only records where created_at is greater than this value.

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

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

created_at__lt

string (date-time)

Only records where created_at is less than this value.

created_at__lt

created_at__lt

Only records where created_at is less than this value.

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

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

updated_at

string (date-time)

Only records where updated_at equals this value.

updated_at

updated_at

Only records where updated_at equals this value.

updated_at__gt

string (date-time)

Only records where updated_at is greater than this value.

updated_at__gt

updated_at__gt

Only records where updated_at is greater than this value.

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

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

updated_at__lt

string (date-time)

Only records where updated_at is less than this value.

updated_at__lt

updated_at__lt

Only records where updated_at is less than this value.

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

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

last

string

Base64-encoded pagination cursor from the previous response, used to retrieve the next page of results

​

Base64-encoded pagination cursor from the previous response, used to retrieve the next page of results

order

string

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

order

​

order

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

order_by

string

Which field to order results by.

order_by

​

order_by

Which field to order results by.

size

integer

Maximum results to include in the response.

• minimum: 1

size

size

Maximum results to include in the response.

• minimum: 1

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

count

integer

Number of service configs matched by the list request

Number of service configs matched by the list request

last

string

Base64-encoded pagination cursor from the previous response, used to retrieve the next page of results

Base64-encoded pagination cursor from the previous response, used to retrieve the next page of results

items

array<object>

id

string

ID of a Prompt Guard service configuration

ID of a Prompt Guard service configuration

name

string

Human-readable name of the Prompt Guard service configuration

Human-readable name of the Prompt Guard service configuration

updated_at

string (date-time)

Database timestamp when the configuration was last updated. Automatically assigned.

Database timestamp when the configuration was last updated. Automatically assigned.

version

string

(default: "v1")

Version tag for the configuration, useful for tracking changes

Version tag for the configuration, useful for tracking changes

analyzers

object

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

Map of Prompt Guard analyzer codes to their enablement status.

Each key must be a valid analyzer code (for example, PA1001, PA4002), and the value indicates whether the analyzer is enabled (true) or disabled (false).

malicious_detection_threshold

number

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as malicious.

• minimum: 0

• maximum: 1

benign_detection_threshold

number, null

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

Minimum confidence required to classify a prompt as benign.

• minimum: 0

• maximum: 1

audit_data_activity

object

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

Configuration for enabling Prompt Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs Prompt Guard service interactions to a tamperproof audit trail, including input/output content and detection results.

enabled

boolean

Whether activity logging is enabled for this configuration

Whether activity logging is enabled for this configuration

audit_service_config_id

string

ID of the Secure Audit Log service configuration where activity events should be recorded

ID of the Secure Audit Log service configuration where activity events should be recorded

areas

object

Specifies which types of Prompt Guard events should be logged

Specifies which types of Prompt Guard events should be logged

malicious_prompt

boolean

Logs requests that Prompt Guard identifies as malicious or risky

Logs requests that Prompt Guard identifies as malicious or risky

benign_prompt

boolean

Logs requests that Prompt Guard identifies as benign

Logs requests that Prompt Guard identifies as benign

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"

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"

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"

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"

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.

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

Was this article helpful?

Contact us