Skip to main content

Prompt Guard Configuration API Reference

Base URL​

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

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

Response

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

string

ID of a Prompt Guard service configuration

object

Pangea standard response schema

object

Configuration used by the Prompt Guard service

string

ID of a Prompt Guard service configuration

string

Human-readable name of the Prompt Guard service configuration

string (date-time)

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

string
(default: "v1")

Version tag for the configuration, useful for tracking changes

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).

number

Minimum confidence required to classify a prompt as malicious.

  • minimum: 0

  • maximum: 1

number, null

Minimum confidence required to classify a prompt as benign.

  • minimum: 0

  • maximum: 1

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.

boolean

Whether activity logging is enabled for this configuration

string

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

object

Specifies which types of Prompt Guard events should be logged

boolean

Logs requests that Prompt Guard identifies as malicious or risky

boolean

Logs requests that Prompt Guard identifies as benign

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

string

Human-readable name of the Prompt Guard service configuration

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).

number

Minimum confidence required to classify a prompt as malicious.

  • minimum: 0

  • maximum: 1

number, null

Minimum confidence required to classify a prompt as benign.

  • minimum: 0

  • maximum: 1

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.

boolean

Whether activity logging is enabled for this configuration

string

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

object

Specifies which types of Prompt Guard events should be logged

boolean

Logs requests that Prompt Guard identifies as malicious or risky

boolean

Logs requests that Prompt Guard identifies as benign

object

Pangea standard response schema

object

Configuration used by the Prompt Guard service

string

ID of a Prompt Guard service configuration

string

Human-readable name of the Prompt Guard service configuration

string (date-time)

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

string
(default: "v1")

Version tag for the configuration, useful for tracking changes

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).

number

Minimum confidence required to classify a prompt as malicious.

  • minimum: 0

  • maximum: 1

number, null

Minimum confidence required to classify a prompt as benign.

  • minimum: 0

  • maximum: 1

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.

boolean

Whether activity logging is enabled for this configuration

string

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

object

Specifies which types of Prompt Guard events should be logged

boolean

Logs requests that Prompt Guard identifies as malicious or risky

boolean

Logs requests that Prompt Guard identifies as benign

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

required parameters

string

ID of a Prompt Guard service configuration

string

Human-readable name of the Prompt Guard service configuration

string (date-time)

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

string
(default: "v1")

Version tag for the configuration, useful for tracking changes

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).

number

Minimum confidence required to classify a prompt as malicious.

  • minimum: 0

  • maximum: 1

number, null

Minimum confidence required to classify a prompt as benign.

  • minimum: 0

  • maximum: 1

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.

boolean

Whether activity logging is enabled for this configuration

string

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

object

Specifies which types of Prompt Guard events should be logged

boolean

Logs requests that Prompt Guard identifies as malicious or risky

boolean

Logs requests that Prompt Guard identifies as benign

object

Pangea standard response schema

object

Configuration used by the Prompt Guard service

string

ID of a Prompt Guard service configuration

string

Human-readable name of the Prompt Guard service configuration

string (date-time)

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

string
(default: "v1")

Version tag for the configuration, useful for tracking changes

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).

number

Minimum confidence required to classify a prompt as malicious.

  • minimum: 0

  • maximum: 1

number, null

Minimum confidence required to classify a prompt as benign.

  • minimum: 0

  • maximum: 1

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.

boolean

Whether activity logging is enabled for this configuration

string

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

object

Specifies which types of Prompt Guard events should be logged

boolean

Logs requests that Prompt Guard identifies as malicious or risky

boolean

Logs requests that Prompt Guard identifies as benign

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

string

ID of a Prompt Guard service configuration

object

Pangea standard response schema

object

Configuration used by the Prompt Guard service

string

ID of a Prompt Guard service configuration

string

Human-readable name of the Prompt Guard service configuration

string (date-time)

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

string
(default: "v1")

Version tag for the configuration, useful for tracking changes

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).

number

Minimum confidence required to classify a prompt as malicious.

  • minimum: 0

  • maximum: 1

number, null

Minimum confidence required to classify a prompt as benign.

  • minimum: 0

  • maximum: 1

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.

boolean

Whether activity logging is enabled for this configuration

string

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

object

Specifies which types of Prompt Guard events should be logged

boolean

Logs requests that Prompt Guard identifies as malicious or risky

boolean

Logs requests that Prompt Guard identifies as benign

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

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

object
string

Only records where id equals this value.

array<string>

Only records where id includes each substring.

Click 'Save' to use the value

array<string>

Only records where id equals one of the provided substrings.

Click 'Save' to use the value

string (date-time)

Only records where created_at equals this value.

string (date-time)

Only records where created_at is greater than this value.

string (date-time)

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

string (date-time)

Only records where created_at is less than this value.

string (date-time)

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

string (date-time)

Only records where updated_at equals this value.

string (date-time)

Only records where updated_at is greater than this value.

string (date-time)

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

string (date-time)

Only records where updated_at is less than this value.

string (date-time)

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

string

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

string

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

string

Which field to order results by.

integer

Maximum results to include in the response.

  • minimum: 1

object

Pangea standard response schema

object
integer

Number of service configs matched by the list request

string

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

array<object>
string

ID of a Prompt Guard service configuration

string

Human-readable name of the Prompt Guard service configuration

string (date-time)

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

string
(default: "v1")

Version tag for the configuration, useful for tracking changes

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).

number

Minimum confidence required to classify a prompt as malicious.

  • minimum: 0

  • maximum: 1

number, null

Minimum confidence required to classify a prompt as benign.

  • minimum: 0

  • maximum: 1

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.

boolean

Whether activity logging is enabled for this configuration

string

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

object

Specifies which types of Prompt Guard events should be logged

boolean

Logs requests that Prompt Guard identifies as malicious or risky

boolean

Logs requests that Prompt Guard identifies as benign

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.

Status Codes​

Was this article helpful?

Contact us