Update

PUT

api_keys

{id}

Update

curl --request PUT \
  --url https://api.incident.io/v1/api_keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comments": "Requested in https://example.slack.com/archives/C123/p456",
  "name": "My test API key",
  "role_names": [
    "viewer",
    "incident_creator"
  ],
  "team_ids": [
    "01FCNDV6P870EA6S7TK1DSYDG0"
  ],
  "team_role_names": [
    "schedules_editor"
  ]
}
'

import requests

url = "https://api.incident.io/v1/api_keys/{id}"

payload = {
    "comments": "Requested in https://example.slack.com/archives/C123/p456",
    "name": "My test API key",
    "role_names": ["viewer", "incident_creator"],
    "team_ids": ["01FCNDV6P870EA6S7TK1DSYDG0"],
    "team_role_names": ["schedules_editor"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comments: 'Requested in https://example.slack.com/archives/C123/p456',
    name: 'My test API key',
    role_names: ['viewer', 'incident_creator'],
    team_ids: ['01FCNDV6P870EA6S7TK1DSYDG0'],
    team_role_names: ['schedules_editor']
  })
};

fetch('https://api.incident.io/v1/api_keys/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.incident.io/v1/api_keys/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'comments' => 'Requested in https://example.slack.com/archives/C123/p456',
    'name' => 'My test API key',
    'role_names' => [
        'viewer',
        'incident_creator'
    ],
    'team_ids' => [
        '01FCNDV6P870EA6S7TK1DSYDG0'
    ],
    'team_role_names' => [
        'schedules_editor'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.incident.io/v1/api_keys/{id}"

	payload := strings.NewReader("{\n  \"comments\": \"Requested in https://example.slack.com/archives/C123/p456\",\n  \"name\": \"My test API key\",\n  \"role_names\": [\n    \"viewer\",\n    \"incident_creator\"\n  ],\n  \"team_ids\": [\n    \"01FCNDV6P870EA6S7TK1DSYDG0\"\n  ],\n  \"team_role_names\": [\n    \"schedules_editor\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.incident.io/v1/api_keys/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comments\": \"Requested in https://example.slack.com/archives/C123/p456\",\n  \"name\": \"My test API key\",\n  \"role_names\": [\n    \"viewer\",\n    \"incident_creator\"\n  ],\n  \"team_ids\": [\n    \"01FCNDV6P870EA6S7TK1DSYDG0\"\n  ],\n  \"team_role_names\": [\n    \"schedules_editor\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.incident.io/v1/api_keys/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comments\": \"Requested in https://example.slack.com/archives/C123/p456\",\n  \"name\": \"My test API key\",\n  \"role_names\": [\n    \"viewer\",\n    \"incident_creator\"\n  ],\n  \"team_ids\": [\n    \"01FCNDV6P870EA6S7TK1DSYDG0\"\n  ],\n  \"team_role_names\": [\n    \"schedules_editor\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "api_key": {
    "comments": "Requested in https://example.slack.com/archives/C123/p456",
    "created_at": "2021-08-17T13:28:57.801578Z",
    "creator": {
      "api_key": {
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "My test API key"
      },
      "user": {
        "email": "lisa@incident.io",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Lisa Karlin Curtis",
        "role": "viewer",
        "slack_user_id": "U02AYNF2XJM"
      }
    },
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "last_used_at": "2021-08-17T13:28:57.801578Z",
    "name": "My test API key",
    "roles": [
      {
        "description": "can view data, like public incidents and organization settings",
        "name": "viewer"
      }
    ],
    "team_ids": [
      "abc123"
    ],
    "team_roles": [
      {
        "description": "can view data, like public incidents and organization settings",
        "name": "catalog_editor"
      }
    ],
    "token_last_issued_at": "2021-08-17T13:28:57.801578Z"
  }
}

Authorizations

Authorization

string

header

required

API key from your incident.io dashboard (Settings → API keys)

Path Parameters

string

required

Unique identifier of the API key to update

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Body

application/json

name

string

required

Human-readable name for the API key

Required string length: 1 - 200

Example:

"My test API key"

role_names

enum<string>[]

required

Account-level roles for the API key. These roles apply across the entire account, not scoped to specific teams. Pass an empty array if no account-level roles are needed.

Available options:

viewer,

incident_creator,

incident_editor,

manage_settings,

global_access,

catalog_viewer,

catalog_editor,

incident_memberships_editor,

schedules_editor,

schedules_reader,

schedule_overrides_editor,

workflows_editor,

private_workflows_editor,

private_escalation_workflows_editor,

on_call_editor,

on_call_viewer,

escalation_creator,

post_incident_flow_opt_out,

security_settings_editor,

investigation_download,

team_memberships_manage,

status_page_publisher,

postmortems_manage,

api_keys_manage,

notification_methods_manage,

notification_methods_unredacted_viewer,

incident_workload_viewer,

incident_workload_private_viewer,

act_on_behalf_of_users

Example:

["viewer", "incident_creator"]

team_ids

string[]

required

IDs of teams to scope the team_role_names to. If provided, team_role_names must also be a non-empty array, and vice versa. Pass an empty array if the key should not be scoped to any teams.

Example:

["01FCNDV6P870EA6S7TK1DSYDG0"]

team_role_names

enum<string>[]

required

Roles to grant for the teams specified in team_ids. If provided, team_ids must also be a non-empty array, and vice versa. Pass an empty array if no team-level roles are needed.

Available options:

catalog_editor,

schedules_editor,

schedules_reader,

schedule_overrides_editor,

on_call_editor,

escalation_creator,

api_keys_manage,

workflows_editor,

private_workflows_editor

Example:

["schedules_editor"]

comments

string

Freeform notes about the API key

Maximum string length: 5000

Pattern: ^[^]*$

Example:

"Requested in https://example.slack.com/archives/C123/p456"

Response

200 - application/json

OK response.

api_key

object

required

Show child attributes

Show

Rotate

⌘I

Update

curl --request PUT \
  --url https://api.incident.io/v1/api_keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comments": "Requested in https://example.slack.com/archives/C123/p456",
  "name": "My test API key",
  "role_names": [
    "viewer",
    "incident_creator"
  ],
  "team_ids": [
    "01FCNDV6P870EA6S7TK1DSYDG0"
  ],
  "team_role_names": [
    "schedules_editor"
  ]
}
'

import requests

url = "https://api.incident.io/v1/api_keys/{id}"

payload = {
    "comments": "Requested in https://example.slack.com/archives/C123/p456",
    "name": "My test API key",
    "role_names": ["viewer", "incident_creator"],
    "team_ids": ["01FCNDV6P870EA6S7TK1DSYDG0"],
    "team_role_names": ["schedules_editor"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comments: 'Requested in https://example.slack.com/archives/C123/p456',
    name: 'My test API key',
    role_names: ['viewer', 'incident_creator'],
    team_ids: ['01FCNDV6P870EA6S7TK1DSYDG0'],
    team_role_names: ['schedules_editor']
  })
};

fetch('https://api.incident.io/v1/api_keys/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.incident.io/v1/api_keys/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'comments' => 'Requested in https://example.slack.com/archives/C123/p456',
    'name' => 'My test API key',
    'role_names' => [
        'viewer',
        'incident_creator'
    ],
    'team_ids' => [
        '01FCNDV6P870EA6S7TK1DSYDG0'
    ],
    'team_role_names' => [
        'schedules_editor'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.incident.io/v1/api_keys/{id}"

	payload := strings.NewReader("{\n  \"comments\": \"Requested in https://example.slack.com/archives/C123/p456\",\n  \"name\": \"My test API key\",\n  \"role_names\": [\n    \"viewer\",\n    \"incident_creator\"\n  ],\n  \"team_ids\": [\n    \"01FCNDV6P870EA6S7TK1DSYDG0\"\n  ],\n  \"team_role_names\": [\n    \"schedules_editor\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.incident.io/v1/api_keys/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comments\": \"Requested in https://example.slack.com/archives/C123/p456\",\n  \"name\": \"My test API key\",\n  \"role_names\": [\n    \"viewer\",\n    \"incident_creator\"\n  ],\n  \"team_ids\": [\n    \"01FCNDV6P870EA6S7TK1DSYDG0\"\n  ],\n  \"team_role_names\": [\n    \"schedules_editor\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.incident.io/v1/api_keys/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comments\": \"Requested in https://example.slack.com/archives/C123/p456\",\n  \"name\": \"My test API key\",\n  \"role_names\": [\n    \"viewer\",\n    \"incident_creator\"\n  ],\n  \"team_ids\": [\n    \"01FCNDV6P870EA6S7TK1DSYDG0\"\n  ],\n  \"team_role_names\": [\n    \"schedules_editor\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "api_key": {
    "comments": "Requested in https://example.slack.com/archives/C123/p456",
    "created_at": "2021-08-17T13:28:57.801578Z",
    "creator": {
      "api_key": {
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "My test API key"
      },
      "user": {
        "email": "lisa@incident.io",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Lisa Karlin Curtis",
        "role": "viewer",
        "slack_user_id": "U02AYNF2XJM"
      }
    },
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "last_used_at": "2021-08-17T13:28:57.801578Z",
    "name": "My test API key",
    "roles": [
      {
        "description": "can view data, like public incidents and organization settings",
        "name": "viewer"
      }
    ],
    "team_ids": [
      "abc123"
    ],
    "team_roles": [
      {
        "description": "can view data, like public incidents and organization settings",
        "name": "catalog_editor"
      }
    ],
    "token_last_issued_at": "2021-08-17T13:28:57.801578Z"
  }
}

Getting started

Webhooks

Audit logs

Deprecated endpoints

Authorizations

Path Parameters

Body

Response