Skip to content
sigiro
Esc
↑↓navigate↵open⌘Jpreview

List ingest keys

Every ingest key of the workspace, newest first, revoked ones included. The secret is never returned.

GET/v1/ingest-keys
Authorization
AuthorizationBearer token (prefixed-api-key) · headerrequired
Responses
200

The workspace's ingest keys

keysIngestKeyInfo[]required
Show properties
Array of IngestKeyInfo
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.

401

Missing or invalid bearer token

403

Not a user's own OAuth access token

Request
curl -X GET '/v1/ingest-keys' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "keys": [
    {
      "created_at": "string",
      "created_by": "string",
      "id": "string",
      "last_used_at": "string",
      "name": "string",
      "revoked_at": "string"
    }
  ]
}

Was this page helpful?