Skip to content
ShipSquares

/api-keys (POST)

POST
/api-keys
 
curl --request POST \
  --url https://example.com/api/v1/api-keys \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "scopes": [ "example" ] }'

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
>= 1 characters <= 120 characters
scopes
Array<string>
<= 32 items
Example generated
{
  "name": "example",
  "scopes": [
    "example"
  ]
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Default Response

Media type application/json
object
key
required
object
id
required
string
name
required
string
scopes
required
Array<string>
lastUsedAt
required
Any of:
string format: date-time
createdAt
required
string format: date-time
token
required
string
Example generated
{
  "key": {
    "id": "example",
    "name": "example",
    "scopes": [
      "example"
    ],
    "lastUsedAt": "2026-04-15T12:00:00Z",
    "createdAt": "2026-04-15T12:00:00Z"
  },
  "token": "example"
}

400

Section titled “400 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}