Create an ingest key

Create a fixed key for a long-running service. Send it as Authorization: Bearer <key> (for example OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer <key>"). It sends telemetry to this workspace and cannot read anything. The response is the only time the key is shown: only its hash is stored.

POST/v1/ingest-keys

Authorization

AuthorizationBearer token (prefixed-api-key) · headerrequired

Request body

requiredapplication/json

namestring | null

A label to tell keys apart, such as the service that uses it. 1 to 64 characters; defaults to "ingest key".

Responses

201

The new key, shown once

created_atstringrequired

RFC 3339.

created_bystringrequired

Subject of the OAuth token that created the key.

idstringrequired

Public key id: the middle part of sigiro_<id>_<secret>.

last_used_atstring | null

RFC 3339; updated at most once a minute per key.

namestringrequired

revoked_atstring | null

RFC 3339; set once the key is revoked.

keystringrequired

The full key. Shown once; only its hash is stored.

400

Invalid name, or the workspace already has 50 active keys

401

Missing or invalid bearer token

403

Not a user's own OAuth access token

Request

curl -X POST '/v1/ingest-keys' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

const response = await fetch("/v1/ingest-keys", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\"\n}"
});

import requests

response = requests.post(
    "/v1/ingest-keys",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\"\n}",
)

Response

{
  "created_at": "string",
  "created_by": "string",
  "id": "string",
  "last_used_at": "string",
  "name": "string",
  "revoked_at": "string",
  "key": "string"
}