curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/api-keys' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"name": "Two-Person Tent",
"scopes": [
"sandbox:create"
],
"expires_in_days": 1
}'
{
"api_key": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"key_prefix": "string",
"scopes": [
"string"
],
"last_used_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"created_at": "2026-08-31T14:22:05Z"
},
"key": "string"
}
Create a new API key
API key created. key is the full plaintext key, returned only once.
POST
/
api
/
v1
/
api-keys
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/api-keys' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"name": "Two-Person Tent",
"scopes": [
"sandbox:create"
],
"expires_in_days": 1
}'
{
"api_key": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"key_prefix": "string",
"scopes": [
"string"
],
"last_used_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"created_at": "2026-08-31T14:22:05Z"
},
"key": "string"
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Request body
CreateApiKeyRequest
string
required
Minimum length:
1. Maximum length: 100.string[]
Minimum items:
1.integer
Minimum:
1. Maximum: 365.Response
object
object
required
string
required
Full plaintext API key; shown only in this response.
Status codes
| Code | Meaning |
|---|---|
201 | API key created. key is the full plaintext key, returned only once. |
400 | Invalid request |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/api-keys' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"name": "Two-Person Tent",
"scopes": [
"sandbox:create"
],
"expires_in_days": 1
}'
{
"api_key": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"key_prefix": "string",
"scopes": [
"string"
],
"last_used_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"created_at": "2026-08-31T14:22:05Z"
},
"key": "string"
}
Last modified on September 21, 2026