Skip to main content
POST
/
v1
/
api-keys
Create Api Key
curl --request POST \
  --url https://api.example.com/v1/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [
    "<string>"
  ],
  "key_type": "human",
  "expires_at": "2023-11-07T05:31:56Z",
  "allowed_sources": [
    "<string>"
  ]
}
'
import requests

url = "https://api.example.com/v1/api-keys"

payload = {
    "name": "<string>",
    "scopes": ["<string>"],
    "key_type": "human",
    "expires_at": "2023-11-07T05:31:56Z",
    "allowed_sources": ["<string>"]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    scopes: ['<string>'],
    key_type: 'human',
    expires_at: '2023-11-07T05:31:56Z',
    allowed_sources: ['<string>']
  })
};

fetch('https://api.example.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.example.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([
    'name' => '<string>',
    'scopes' => [
        '<string>'
    ],
    'key_type' => 'human',
    'expires_at' => '2023-11-07T05:31:56Z',
    'allowed_sources' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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.example.com/v1/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"key_type\": \"human\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"allowed_sources\": [\n    \"<string>\"\n  ]\n}")

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

	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("https://api.example.com/v1/api-keys")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"key_type\": \"human\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"allowed_sources\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/api-keys")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"key_type\": \"human\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"allowed_sources\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "key_prefix": "<string>",
    "key": "<string>",
    "scopes": [
      "<string>"
    ],
    "key_type": "<string>",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "allowed_sources": [
      "<string>"
    ]
  },
  "meta": {}
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json
name
string
required

Human-readable label

Required string length: 1 - 255
scopes
string[]
required

Granted scopes

Minimum array length: 1
key_type
string
default:human

Key type: 'human' or 'agent'

expires_at
string<date-time> | null

Optional expiry (UTC ISO 8601)

allowed_sources
string[] | null

Restrict ingestion to these source names (null = unrestricted)

Response

Successful Response

data
APIKeyCreated · object
required

Returned only by POST /v1/api-keys. Contains the full plain-text key (shown once).

meta
Meta · object