API

Every pagerduty.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Incident Notes

create

incidentNotes.create Add a note to an incident Risk: write

await corsair.pagerduty.api.incidentNotes.create({});

Input

Name	Type	Required	Description
`incident_id`	`string`	Yes	—
`content`	`string`	Yes	—

Output

Name	Type	Required	Description
`note`	`object`	Yes	—

note full type

{
  id: string,
  content?: string,
  created_at?: string,
  user?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  channel?: {
    type?: string,
    name?: string
  }
}

list

incidentNotes.list List notes for an incident Risk: read

await corsair.pagerduty.api.incidentNotes.list({});

Input

Name	Type	Required	Description
`incident_id`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`notes`	`object[]`	Yes	—

notes full type

{
  id: string,
  content?: string,
  created_at?: string,
  user?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  channel?: {
    type?: string,
    name?: string
  }
}[]

Incidents

create

incidents.create Create a new incident Risk: write

await corsair.pagerduty.api.incidents.create({});

Input

Name	Type	Required	Description
`title`	`string`	Yes	—
`from`	`string`	Yes	—
`service`	`object`	Yes	—
`urgency`	`high \| low`	No	—
`body`	`object`	No	—
`escalation_policy`	`object`	No	—
`assignments`	`object[]`	No	—

service full type

{
  id: string,
  type: service_reference
}

body full type

{
  type: incident_body,
  details: string
}

escalation_policy full type

{
  id: string,
  type: escalation_policy_reference
}

assignments full type

{
  assignee: {
    id: string,
    type: user_reference
  }
}[]

Output

Name	Type	Required	Description
`incident`	`object`	Yes	—

incident full type

{
  id: string,
  incident_number?: number,
  title?: string,
  status?: triggered | acknowledged | resolved,
  urgency?: high | low,
  html_url?: string,
  created_at?: string,
  updated_at?: string,
  resolved_at?: string | null,
  service?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  escalation_policy?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  teams?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  }[],
  assignments?: {
    at: string,
    assignee: {
      id: string,
      type: string,
      summary?: string,
      html_url?: string | null
    }
  }[],
  body?: {
    type?: string,
    details?: string
  }
}

get

incidents.get Get a single incident by ID Risk: read

await corsair.pagerduty.api.incidents.get({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`incident`	`object`	Yes	—

incident full type

{
  id: string,
  incident_number?: number,
  title?: string,
  status?: triggered | acknowledged | resolved,
  urgency?: high | low,
  html_url?: string,
  created_at?: string,
  updated_at?: string,
  resolved_at?: string | null,
  service?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  escalation_policy?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  teams?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  }[],
  assignments?: {
    at: string,
    assignee: {
      id: string,
      type: string,
      summary?: string,
      html_url?: string | null
    }
  }[],
  body?: {
    type?: string,
    details?: string
  }
}

list

incidents.list List incidents with optional filters Risk: read

await corsair.pagerduty.api.incidents.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`statuses`	`triggered \| acknowledged \| resolved[]`	No	—
`since`	`string`	No	—
`until`	`string`	No	—
`urgencies`	`high \| low[]`	No	—
`service_ids`	`string[]`	No	—
`team_ids`	`string[]`	No	—
`sort_by`	`string`	No	—

Output

Name	Type	Required	Description
`incidents`	`object[]`	Yes	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`more`	`boolean`	No	—
`total`	`number`	No	—

incidents full type

{
  id: string,
  incident_number?: number,
  title?: string,
  status?: triggered | acknowledged | resolved,
  urgency?: high | low,
  html_url?: string,
  created_at?: string,
  updated_at?: string,
  resolved_at?: string | null,
  service?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  escalation_policy?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  teams?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  }[],
  assignments?: {
    at: string,
    assignee: {
      id: string,
      type: string,
      summary?: string,
      html_url?: string | null
    }
  }[],
  body?: {
    type?: string,
    details?: string
  }
}[]

update

incidents.update Update an incident (acknowledge, resolve, reassign) Risk: write

await corsair.pagerduty.api.incidents.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`acknowledged \| resolved`	No	—
`urgency`	`high \| low`	No	—
`title`	`string`	No	—
`assignments`	`object[]`	No	—
`escalation_policy`	`object`	No	—

assignments full type

{
  assignee: {
    id: string,
    type: user_reference
  }
}[]

escalation_policy full type

{
  id: string,
  type: escalation_policy_reference
}

Output

Name	Type	Required	Description
`incident`	`object`	Yes	—

incident full type

{
  id: string,
  incident_number?: number,
  title?: string,
  status?: triggered | acknowledged | resolved,
  urgency?: high | low,
  html_url?: string,
  created_at?: string,
  updated_at?: string,
  resolved_at?: string | null,
  service?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  escalation_policy?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  teams?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  }[],
  assignments?: {
    at: string,
    assignee: {
      id: string,
      type: string,
      summary?: string,
      html_url?: string | null
    }
  }[],
  body?: {
    type?: string,
    details?: string
  }
}

Log Entries

get

logEntries.get Get a single log entry by ID Risk: read

await corsair.pagerduty.api.logEntries.get({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`include`	`string[]`	No	—

Output

Name	Type	Required	Description
`log_entry`	`object`	Yes	—

log_entry full type

{
  id: string,
  type?: string,
  summary?: string,
  created_at?: string,
  html_url?: string | null,
  incident?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  service?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  teams?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  }[],
  agent?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  channel?: {
    type: string,
    name?: string
  }
}

list

logEntries.list List log entries Risk: read

await corsair.pagerduty.api.logEntries.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`since`	`string`	No	—
`until`	`string`	No	—
`is_overview`	`boolean`	No	—
`include`	`string[]`	No	—
`team_ids`	`string[]`	No	—

Output

Name	Type	Required	Description
`log_entries`	`object[]`	Yes	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`more`	`boolean`	No	—
`total`	`number`	No	—

log_entries full type

{
  id: string,
  type?: string,
  summary?: string,
  created_at?: string,
  html_url?: string | null,
  incident?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  service?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  teams?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  }[],
  agent?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  },
  channel?: {
    type: string,
    name?: string
  }
}[]

Users

get

users.get Get a user by ID Risk: read

await corsair.pagerduty.api.users.get({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`include`	`string[]`	No	—

Output

Name	Type	Required	Description
`user`	`object`	Yes	—

user full type

{
  id: string,
  name?: string,
  email?: string,
  role?: string,
  description?: string | null,
  time_zone?: string,
  html_url?: string,
  avatar_url?: string,
  color?: string,
  contact_methods?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  }[],
  notification_rules?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  }[],
  teams?: {
    id: string,
    type: string,
    summary?: string,
    html_url?: string | null
  }[]
}

Overview

Plugins

Incident Notes

create

list

Incidents

create

get

list

update

Log Entries

get

list

Users

get

Overview

Plugins

​Incident Notes

​create

​list

​Incidents

​create

​get

​list

​update

​Log Entries

​get

​list

​Users

​get

Incident Notes

create

list

Incidents

create

get

list

update

Log Entries

get

list

Users

get