PagerDuty API

Use these operations to interact with the PagerDuty integration in Cortex.

Required permissions

Your API key must have the Configure integrations permission.

Operations

Retrieve a configuration

get
Authorizations
Responses
200
Successfully found configuration
application/json
get
GET /api/v1/pagerduty/default-configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "isTokenReadonly": true,
  "lastFour": "text"
}

Add a configuration

post
Authorizations
Body
isTokenReadonlybooleanRequired
tokenstringRequired
Responses
200
Successfully added configuration
application/json
post
POST /api/v1/pagerduty/configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "isTokenReadonly": true,
  "token": "text"
}
{
  "configurations": [
    {
      "isTokenReadonly": true,
      "lastFour": "text"
    }
  ]
}

Replace the existing configuration

put
Authorizations
Body
isTokenReadonlybooleanRequired
tokenstringRequired
Responses
200
Successfully replaces configuration
application/json
put
PUT /api/v1/pagerduty/configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "isTokenReadonly": true,
  "token": "text"
}
{
  "configurations": [
    {
      "isTokenReadonly": true,
      "lastFour": "text"
    }
  ]
}

Validate a configuration

post
Authorizations
Responses
200
Successfully validated configuration
application/json
post
POST /api/v1/pagerduty/configuration/validate HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "configurations": [
    {
      "alias": "text",
      "isValid": true,
      "message": "text"
    }
  ]
}

Delete a configuration

delete
Authorizations
Responses
200
Successfully deleted configuration
application/json
delete
DELETE /api/v1/pagerduty/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "configurations": [
    {
      "isTokenReadonly": true,
      "lastFour": "text"
    }
  ]
}

Last updated

Was this helpful?