How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PagerDuty Custom Fields API

Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle.

PagerDuty Custom Fields API is one of 38 APIs that PagerDuty publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Custom Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and an AsyncAPI specification.

This API exposes 9 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.2, at version 2.0.0.

Requests are made against a single base URL, https://api.pagerduty.com.

9 operations 4 paths 6 schemas 2 DELETE3 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
2.0.0
Base URL
https://api.pagerduty.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

PagerDuty Custom Fields API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key). By default, every request must be authenticated.

  • api_key — The API Key with format Token token=

Paths & Operations 9

Across 4 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Fields 9

Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle.

POST
/incidents/custom_fields
PagerDuty Create a Field
createCustomFieldsField body → 201400403500
GET
/incidents/custom_fields
PagerDuty List Fields
listCustomFieldsFields 1 param → 200400500
GET
/incidents/custom_fields/{field_id}
PagerDuty Get a Field
getCustomFieldsField 2 params → 200403404500
PUT
/incidents/custom_fields/{field_id}
PagerDuty Update a Field
updateCustomFieldsField 1 param body → 200400403404500
DELETE
/incidents/custom_fields/{field_id}
PagerDuty Delete a Field
deleteCustomFieldsField 1 param → 204400403404500
POST
/incidents/custom_fields/{field_id}/field_options
PagerDuty Create a Field Option
createCustomFieldsFieldOption 1 param body → 201400403404500
GET
/incidents/custom_fields/{field_id}/field_options
PagerDuty List Field Options
listCustomFieldsFieldOptions 1 param → 200404500
PUT
/incidents/custom_fields/{field_id}/field_options/{field_option_id}
PagerDuty Update a Field Option
updateCustomFieldsFieldOption 2 params body → 200400403404500
DELETE
/incidents/custom_fields/{field_id}/field_options/{field_option_id}
PagerDuty Delete a Field Option
deleteCustomFieldsFieldOption 2 params → 204400403404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CustomFieldsFieldValue (8 properties), CustomFieldsEditableFieldOption (5 properties), CustomFieldsEditableField (3 properties). Each schema is shown below with its type and property counts.

CustomFieldsFieldValue
object
8 properties 8 required
CustomFieldsEditableField
object
3 properties
CustomFieldsField
11 required
CustomFieldsFieldOption
CustomFieldsEditableFieldOption
object
5 properties 4 required
CustomFieldsFieldWithOptions

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pagerduty-custom-fields-api-openapi.yml Raw ↑

Other APIs PagerDuty publishes across the network.

PagerDuty Events API
PagerDuty Abilities API
PagerDuty Add-Ons API
PagerDuty Alert Grouping Settings API
PagerDuty Analytics API
PagerDuty Audit API
PagerDuty Automation Actions API
PagerDuty Business Services API
PagerDuty Change Events API
PagerDuty Change Tags API
PagerDuty Escalation Policies API
PagerDuty Event Orchestrations API
Where this information came from

This is an independent, third-party profile of PagerDuty Custom Fields API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.