Create API key

Create a new API key for service-to-service authentication. JWT/session only — API keys cannot manage API keys. Scopes must be grantable by the creator; "*" is organization-owner only, and "*" or empty is rejected when projectId binds the key. expiresAt is required, in the future, within 365 days

posthttps://localhost:8080/api/v1/api-keys

bash

curl --request POST \
  --url 'https://localhost:8080/api/v1/api-keys' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"allowedIps":["string"],"description":"string","expiresAt":"2026-12-31T23:59:59Z","name":"string","organizationId":0,"projectId":0,"scopes":["string"]}'

javascript

const response = await fetch("https://localhost:8080/api/v1/api-keys", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "allowedIps": [
      "string"
    ],
    "description": "string",
    "expiresAt": "2026-12-31T23:59:59Z",
    "name": "string",
    "organizationId": 0,
    "projectId": 0,
    "scopes": [
      "string"
    ]
  })
});

const data = await response.json();

typescript

interface CreateAPIKeyResponse {
  apiKey?: Record<string, unknown>;
  plainKey?: string;
}

const response = await fetch("https://localhost:8080/api/v1/api-keys", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "allowedIps": [
      "string"
    ],
    "description": "string",
    "expiresAt": "2026-12-31T23:59:59Z",
    "name": "string",
    "organizationId": 0,
    "projectId": 0,
    "scopes": [
      "string"
    ]
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: CreateAPIKeyResponse = await response.json();

python

import requests

response = requests.post(
    "https://localhost:8080/api/v1/api-keys",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "allowedIps": [
            "string",
        ],
        "description": "string",
        "expiresAt": "2026-12-31T23:59:59Z",
        "name": "string",
        "organizationId": 0,
        "projectId": 0,
        "scopes": [
            "string",
        ],
    },
)
response.raise_for_status()
print(response.json())

package main

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

func main() {
	body := strings.NewReader(`{
	  "allowedIps": [
	    "string"
	  ],
	  "description": "string",
	  "expiresAt": "2026-12-31T23:59:59Z",
	  "name": "string",
	  "organizationId": 0,
	  "projectId": 0,
	  "scopes": [
	    "string"
	  ]
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://localhost:8080/api/v1/api-keys", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}

java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:8080/api/v1/api-keys"))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
                {
                  "allowedIps": [
                    "string"
                  ],
                  "description": "string",
                  "expiresAt": "2026-12-31T23:59:59Z",
                  "name": "string",
                  "organizationId": 0,
                  "projectId": 0,
                  "scopes": [
                    "string"
                  ]
                }
                """))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

csharp

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://localhost:8080/api/v1/api-keys");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "allowedIps": [
        "string"
      ],
      "description": "string",
      "expiresAt": "2026-12-31T23:59:59Z",
      "name": "string",
      "organizationId": 0,
      "projectId": 0,
      "scopes": [
        "string"
      ]
    }
    """, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

php

<?php

$ch = curl_init('https://localhost:8080/api/v1/api-keys');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "allowedIps": [
        "string"
      ],
      "description": "string",
      "expiresAt": "2026-12-31T23:59:59Z",
      "name": "string",
      "organizationId": 0,
      "projectId": 0,
      "scopes": [
        "string"
      ]
    }
    JSON,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;

ruby

require "net/http"

uri = URI("https://localhost:8080/api/v1/api-keys")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "allowedIps": [
      "string"
    ],
    "description": "string",
    "expiresAt": "2026-12-31T23:59:59Z",
    "name": "string",
    "organizationId": 0,
    "projectId": 0,
    "scopes": [
      "string"
    ]
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"

rust

// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .post("https://localhost:8080/api/v1/api-keys")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "allowedIps": [
                "string"
            ],
            "description": "string",
            "expiresAt": "2026-12-31T23:59:59Z",
            "name": "string",
            "organizationId": 0,
            "projectId": 0,
            "scopes": [
                "string"
            ]
        }))
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token

Request bodyrequired

API key configuration

application/json

allowedIpsstring[]
Enforced on every request when set
descriptionstringrequired
expiresAtstring<date-time>required
Future, within MaxAPIKeyLifetime
namestringrequired
organizationIdinteger
Scopes the key to an organization
projectIdinteger
Scopes the key to a project
scopesstring[]
"*" (full access) must be alone

Examplejson

{
  "allowedIps": [
    "string"
  ],
  "description": "string",
  "expiresAt": "2026-12-31T23:59:59Z",
  "name": "string",
  "organizationId": 0,
  "projectId": 0,
  "scopes": [
    "string"
  ]
}

Responses

200Created API key (key shown only once)

application/json

apiKeycore.APIKey
An API key for service-to-service authentication; the secret itself is never returned here
Show core.APIKey
- allowedIpsstring[]
- createdAtstring<date-time>read-only
- createdBystringread-only
- descriptionstring
- expiresAtstring<date-time>
- idstringread-only
- keyIdstringread-only
- lastUsedAtstring<date-time>read-only
- namestring
- organizationIdinteger
- projectIdinteger
- revocationReasonstringread-only
  Set via the revoke endpoint
- revokedAtstring<date-time>read-only
- revokedBystringread-only
- scopesstring[]
- statusstring (enum)read-only
  One ofactiveexpiredrevoked
- usageCountintegerread-only
- userIdstringread-only
  Resolved from the caller
plainKeystring
Only returned once during creation

Examplejson

{
  "apiKey": {
    "allowedIps": [
      "string"
    ],
    "description": "string",
    "expiresAt": "2025-01-01T00:00:00Z",
    "name": "string",
    "organizationId": 0,
    "projectId": 0,
    "scopes": [
      "string"
    ]
  },
  "plainKey": "string"
}

400Bad request - Invalid body, name, description, expiry, or scopes

application/json

errorstring
error_descriptionstring

Examplejson

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401Unauthorized - Authentication required

application/json

errorstring
error_descriptionstring

Examplejson

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403Forbidden - API keys cannot manage API keys

application/json

errorstring
error_descriptionstring

Examplejson

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500Internal server error

application/json

errorstring
error_descriptionstring

Examplejson

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}