Skip to content

Generate API key

POST
/admin/api-keys
curl --request POST \
--url https://shoehorn.example.com/api/v1/admin/api-keys \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "scopes": [ "catalog" ], "expires_at": "2026-04-15T12:00:00Z" }'
Media type application/json
object
name
required
string
scopes
required
Array<string>
Allowed values: catalog forge repositories k8s-agents operations admin internal:service
expires_at
string format: date-time

API key generated (token shown only once)

Media type application/json
object
id
string
name
string
token

Full token (shp_svc_…) - shown only at creation

string
scopes
Array<string>
Example generated
{
"id": "example",
"name": "example",
"token": "example",
"scopes": [
"example"
]
}