|docs
Start Trial
REST APIEnrichment schemas

Query enrichment data

Query an enrichment schema for records matching a set of field values. Supply up to 3 query fields; all must match. Returns at most one record for standard schemas, or multiple records for schemas that use a discriminator field.

Early Access

This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.

Scoped OAuth requires: contextual_data.read

Authorization

api_key
Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"
Content-Type*"application/json"
Default"application/json"

Value in

  • "application/json"

Request Body

application/json

The schema and query field values to match enrichment records against.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

List enrichment schemas GET

Lists all enrichment schemas for the account. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.read`

Update an enrichment schema PUT

Updates the name and/or description of an enrichment schema. At least one of `name` or `description` must be provided. Schema fields cannot be changed after creation. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`