Sign in

v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Enrichment Schemas

Create an enrichment schema

Creates an enrichment schema. Provide a JSON body to define the schema explicitly (returns 201), or upload a CSV file as multipart/form-data or text/csv to auto-generate a schema from the file's columns — the first column becomes a query field and the rest become enriched fields (returns 202 once the file is accepted for processing). A schema must include 1-3 query fields and at least one enriched field, up to 25 fields total, with unique (case-insensitive) field names. Schemas created through the API are always CSV, and an account may have at most 25 CSV schemas. CSV uploads are limited to 10 MB.

<!-- 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

post/enrichment/schemas

Query parameters

filenamestring

The filename for the CSV content. Required when creating a schema from a text/csv body; optional for text/csv record uploads. Ignored for multipart/form-data and JSON requests.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Request body

integration_type'CSV'

The schema source. Only CSV is supported through the API; the schema is always recorded as CSV regardless of the value sent.

namestring required

Display name of the enrichment schema.

descriptionstring

Description of this set of enrichment data.

Response

The enrichment schema was created successfully.

Example response

{
  "schema": {
    "type": "enrichment_schema"
  }
}