API Keys
Creates an API key
Creates 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). Requiresgroup_id. A service account is automatically created with permissions derived from group membership.organization— organization-wide access. Requires owner or admin role. Optionally setrole_idandon_call_role_idto 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.
POST
/
v1
/
api_keys
Creates an API key
curl --request POST \
--url https://api.rootly.com/v1/api_keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "api_keys",
"attributes": {
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"group_id": "<string>",
"role_id": "<string>",
"on_call_role_id": "<string>"
}
}
}
'import requests
url = "https://api.rootly.com/v1/api_keys"
payload = { "data": {
"type": "api_keys",
"attributes": {
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"group_id": "<string>",
"role_id": "<string>",
"on_call_role_id": "<string>"
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'api_keys',
attributes: {
name: '<string>',
expires_at: '2023-11-07T05:31:56Z',
description: '<string>',
group_id: '<string>',
role_id: '<string>',
on_call_role_id: '<string>'
}
}
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'api_keys',
'attributes' => [
'name' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'group_id' => '<string>',
'role_id' => '<string>',
'on_call_role_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+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.rootly.com/v1/api_keys"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"api_keys\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"group_id\": \"<string>\",\n \"role_id\": \"<string>\",\n \"on_call_role_id\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.rootly.com/v1/api_keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"api_keys\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"group_id\": \"<string>\",\n \"role_id\": \"<string>\",\n \"on_call_role_id\": \"<string>\"\n }\n }\n}")
.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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"api_keys\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"group_id\": \"<string>\",\n \"role_id\": \"<string>\",\n \"on_call_role_id\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "api_keys",
"attributes": {
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"token": "<string>",
"description": "<string>",
"role_id": "<string>",
"on_call_role_id": "<string>",
"expires_at": "<string>",
"last_used_at": "<string>",
"grace_period_ends_at": "<string>"
}
},
"included": [
{
"id": "<string>",
"type": "<string>",
"attributes": {},
"relationships": {}
}
]
}{
"errors": [
{
"title": "<string>",
"status": "<string>",
"code": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"title": "<string>",
"status": "<string>",
"code": "<string>",
"detail": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/vnd.api+json
Show child attributes
Show child attributes
Was this page helpful?
Previous
Retrieves an API keyRetrieves a specific API key by its UUID. Returns key metadata including name, kind, expiration, last usage timestamp, and the grace period status — the secret token is never included.
Next
⌘I
Creates an API key
curl --request POST \
--url https://api.rootly.com/v1/api_keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "api_keys",
"attributes": {
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"group_id": "<string>",
"role_id": "<string>",
"on_call_role_id": "<string>"
}
}
}
'import requests
url = "https://api.rootly.com/v1/api_keys"
payload = { "data": {
"type": "api_keys",
"attributes": {
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"group_id": "<string>",
"role_id": "<string>",
"on_call_role_id": "<string>"
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'api_keys',
attributes: {
name: '<string>',
expires_at: '2023-11-07T05:31:56Z',
description: '<string>',
group_id: '<string>',
role_id: '<string>',
on_call_role_id: '<string>'
}
}
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'api_keys',
'attributes' => [
'name' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'group_id' => '<string>',
'role_id' => '<string>',
'on_call_role_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+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.rootly.com/v1/api_keys"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"api_keys\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"group_id\": \"<string>\",\n \"role_id\": \"<string>\",\n \"on_call_role_id\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.rootly.com/v1/api_keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"api_keys\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"group_id\": \"<string>\",\n \"role_id\": \"<string>\",\n \"on_call_role_id\": \"<string>\"\n }\n }\n}")
.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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"api_keys\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"group_id\": \"<string>\",\n \"role_id\": \"<string>\",\n \"on_call_role_id\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "api_keys",
"attributes": {
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"token": "<string>",
"description": "<string>",
"role_id": "<string>",
"on_call_role_id": "<string>",
"expires_at": "<string>",
"last_used_at": "<string>",
"grace_period_ends_at": "<string>"
}
},
"included": [
{
"id": "<string>",
"type": "<string>",
"attributes": {},
"relationships": {}
}
]
}{
"errors": [
{
"title": "<string>",
"status": "<string>",
"code": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"title": "<string>",
"status": "<string>",
"code": "<string>",
"detail": "<string>"
}
]
}