API Keys

List API keys

List API keys for the current organization. Returns key metadata including name, kind, expiration, and last usage — the secret token value is never included in the response.

API key kinds:

personal — tied to a specific user, inherits that user’s permissions.
team — scoped to one or more teams (groups), creates a service account with permissions derived from group membership.
organization — organization-wide, creates a service account with a configurable role and on-call role.

Automated rotation workflow: Use filter[expires_at][lt] to find keys approaching expiration, then call the rotate endpoint to issue a new token before the old one expires. Combine with filter[active]=true to exclude already-expired keys.

Sorting: Use the sort parameter with a field name (e.g., sort=expires_at). Prefix with - for descending order (e.g., sort=-created_at). Allowed fields: name, kind, created_at, updated_at, expires_at, last_used_at.

GET

api_keys

List API keys

curl --request GET \
  --url https://api.rootly.com/v1/api_keys \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.rootly.com/v1/api_keys"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/api_keys', 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.rootly.com/v1/api_keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.rootly.com/v1/api_keys"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.rootly.com/v1/api_keys")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/api_keys")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "type": "api_keys",
      "attributes": {
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "description": "<string>",
        "role_id": "<string>",
        "on_call_role_id": "<string>",
        "expires_at": "<string>",
        "last_used_at": "<string>",
        "grace_period_ends_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include

string

Comma-separated list of relationships to include (role, on_call_role, created_by, groups)

page[number]

integer

page[size]

integer

filter[kind]

string

Filter by API key kind: personal, team, organization

filter[search]

string

Search by name (case-insensitive partial match)

filter[name]

string

Filter by exact name

filter[user_id]

string

Filter by the user ID that owns the key

filter[group_ids]

string

Filter team keys by group IDs (comma-separated)

filter[role_id]

string

Filter by role ID

filter[active]

boolean

When true, return only non-expired keys

filter[expired]

boolean

When true, return only expired keys

filter[created_at][gt]

string

Created after (ISO 8601)

filter[created_at][gte]

string

Created at or after (ISO 8601)

filter[created_at][lt]

string

Created before (ISO 8601)

filter[created_at][lte]

string

Created at or before (ISO 8601)

filter[expires_at][gt]

string

Expires after (ISO 8601)

filter[expires_at][gte]

string

Expires at or after (ISO 8601)

filter[expires_at][lt]

string

Expires before (ISO 8601). Useful for finding keys approaching expiration.

filter[expires_at][lte]

string

Expires at or before (ISO 8601)

filter[last_used_at][gt]

string

Last used after (ISO 8601)

filter[last_used_at][gte]

string

Last used at or after (ISO 8601)

filter[last_used_at][lt]

string

Last used before (ISO 8601)

filter[last_used_at][lte]

string

Last used at or before (ISO 8601)

sort

string

Sort by field. Prefix with - for descending (e.g., -created_at, expires_at)

Response

success

data

object[]

required

Show child attributes

links

object

required

Show child attributes

meta

object

required

Show child attributes

included

object[]

Show child attributes

Creates an API keyCreates a new API key and returns it with the plaintext token. **The token is only returned once** — store it securely, as it cannot be retrieved again. **Kinds and required fields:** - `personal` — created for the authenticated user. No additional fields required. - `team` — scoped to a team (group). Requires `group_id`. A service account is automatically created with permissions derived from group membership. - `organization` — organization-wide access. Requires owner or admin role. Optionally set `role_id` and `on_call_role_id` to control the service account's permissions. **Expiration:** All keys require an `expires_at` date set in the future (maximum 5 years). Names must be unique within their kind and scope.

⌘I

List API keys

curl --request GET \
  --url https://api.rootly.com/v1/api_keys \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.rootly.com/v1/api_keys"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/api_keys', 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.rootly.com/v1/api_keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.rootly.com/v1/api_keys"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.rootly.com/v1/api_keys")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/api_keys")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "type": "api_keys",
      "attributes": {
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "description": "<string>",
        "role_id": "<string>",
        "on_call_role_id": "<string>",
        "expires_at": "<string>",
        "last_used_at": "<string>",
        "grace_period_ends_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}