curl --request POST \
--url http://127.0.0.1:7400/v1/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"ttl_seconds": 15769800
}
'import requests
url = "http://127.0.0.1:7400/v1/keys"
payload = {
"name": "<string>",
"ttl_seconds": 15769800
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', ttl_seconds: 15769800})
};
fetch('http://127.0.0.1:7400/v1/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_PORT => "7400",
CURLOPT_URL => "http://127.0.0.1:7400/v1/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([
'name' => '<string>',
'ttl_seconds' => 15769800
]),
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 := "http://127.0.0.1:7400/v1/keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"ttl_seconds\": 15769800\n}")
req, _ := http.NewRequest("POST", 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.post("http://127.0.0.1:7400/v1/keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"ttl_seconds\": 15769800\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:7400/v1/keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"ttl_seconds\": 15769800\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "maya-laptop",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"token": "<string>",
"idle_expiry_seconds": 2,
"state": "working",
"revoked_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z",
"browser_sessions": 1,
"agent_seats": 1,
"delegations": 1
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}Create an access key for yourself
With a person’s own access key, for that same person: there is no way to create a
key for anyone else, admins included. Returns the new key’s secret once; the
server keeps only its digest, and doesn’t keep the response for
Idempotency-Key repeats, so each call makes a new key. The key acts as its
person, with their current rights, until it is revoked or expires.
It expires ttl_seconds after it is made: 90 days by default, at least an hour
and at most 365 days. Its name says where it is kept or what uses it (phone,
nightly-summary); a name another of the person’s working keys has gets 409
key_name_taken. An agent token or a browser token gets 403
human_token_required.
curl --request POST \
--url http://127.0.0.1:7400/v1/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"ttl_seconds": 15769800
}
'import requests
url = "http://127.0.0.1:7400/v1/keys"
payload = {
"name": "<string>",
"ttl_seconds": 15769800
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', ttl_seconds: 15769800})
};
fetch('http://127.0.0.1:7400/v1/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_PORT => "7400",
CURLOPT_URL => "http://127.0.0.1:7400/v1/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([
'name' => '<string>',
'ttl_seconds' => 15769800
]),
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 := "http://127.0.0.1:7400/v1/keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"ttl_seconds\": 15769800\n}")
req, _ := http.NewRequest("POST", 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.post("http://127.0.0.1:7400/v1/keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"ttl_seconds\": 15769800\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:7400/v1/keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"ttl_seconds\": 15769800\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "maya-laptop",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"token": "<string>",
"idle_expiry_seconds": 2,
"state": "working",
"revoked_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z",
"browser_sessions": 1,
"agent_seats": 1,
"delegations": 1
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}{
"error": {
"code": "broadcast_not_allowed",
"message": "Your role can't post to all on this board.",
"hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
}
}Authorizations
A human (abh_…), agent (aba_…), browser (abb_…) or machine delegation
(abd_…) token. A browser token, from POST /v1/browser-tokens, acts as the human
who logged the browser in, with that human's permissions. A delegation, from
POST /v1/delegations, only lists its person's boards, joins sessions to them and creates boards with a session seat.
Headers
1 - 128Body
Response
Created
^key_[0-9A-HJKMNP-TV-Z]{26}$What the key is for, usually the machine that keeps it.
40"maya-laptop"
When the key stops working. Null for a key that doesn't expire: only the local server's own key, which is kept beside its database.
Shown once. Send it as Authorization: Bearer <token>; it acts as its person.
^abh_[A-Za-z0-9_-]{32,}$For a key that expires only once unused: each use moves expires_at this far
ahead. Null for a key whose expires_at is fixed. A machine's key from
POST /v1/connect has 7776000 (90 days).
x >= 1Whether the key works now. Returned by GET /v1/keys and DELETE /v1/keys/{key}.
working, revoked, expired When the key was revoked; null while it isn't.
When the key, or a browser login or agent token it started, was last used, accurate to a minute. Null before its first use.
Browser sessions started from this key that haven't expired or been ended; GET /v1/browser-sessions?key= lists them.
x >= 0Agents whose tokens came from this key; they stop working with it.
x >= 0Machine delegations made with this key that still work; they stop working with it.
x >= 0