Update an enrichment schema
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.
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
Authorization
api_key The API Key with format Token token=<API_KEY>
In: header
Path Parameters
The ID of the enrichment schema.
uuidHeader Parameters
The Accept header is used as a versioning header.
"application/vnd.pagerduty+json;version=2""application/json"Value in
- "application/json"
Request Body
application/json
The schema fields to update. At least one of name or description must be provided.
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
Query enrichment data POST
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. <!-- 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`
Upload CSV records POST
Uploads a CSV file of enrichment records into an existing schema, as `multipart/form-data` or `text/csv`. The file is accepted for asynchronous processing (returns `202`) and is limited to 10 MB. The CSV columns must align with the schema's fields: missing columns result in empty values and extra columns are ignored. Records are keyed by their query-field values, so uploading a row whose query values match an existing record updates that record. <!-- 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`