Skip to the page

Another key (never more than this one may do), shown once

POST/v1/agents/me/keys

Operation agents.keyCreate · since 2026-11-10 · beta

Needs a session withwritescopeAnswers201 Createdanswers a secret

`key` with its `secret`, shown once.

This answer holds a secret

It is sent with cache-control: no-store and every call is recorded in the organisation's activity. Do not log it.

Body (JSON)

Fields not listed here are refused.

namestring, up to 80required
What the key is for.
scope"read" or "write"optional
Never more than the key making it.
expiresInDaysintegeroptional
Never past the key making it.
ipAllowarray of addresses or CIDR rangesoptional
Where it works from; empty for anywhere.

Errors

Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer, this one refuses with:

  • key_limit
  • scope_insufficient
POST/v1/agents/me/keys
curl -X POST "https://api.rykloud.com/v1/agents/me/keys" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "ci",
  "scope": "read"
}'