Skip to main content
POST
/
api
/
v1
/
api-keys
Create API key
curl --request POST \
  --url https://api.uplint.dev/api/v1/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Backend Service",
  "scopes": [
    "upload",
    "download",
    "metadata"
  ],
  "expires_in_days": 90
}
'
{
  "status": "SUCCESS",
  "message": "API key created",
  "data": {
    "api_key_id": "6612f1a2c3b4d5e6f7890123",
    "api_key": "ul_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "name": "Backend Service",
    "scopes": [
      "upload",
      "download",
      "metadata"
    ],
    "expires_at": "2026-05-11T00:00:00Z"
  },
  "timestamp": "2026-02-10T12:00:00Z"
}

Authorizations

Authorization
string
header
required

Pass an API key or JWT token. API keys can be sent as Authorization: Bearer <key> or Authorization: <key>.

Body

application/json
name
string
required

A human-readable name for the key.

Required string length: 1 - 255
scopes
enum<string>[]

Permissions granted to this key.

Permission scope for an API key. admin grants all permissions.

Available options:
upload,
download,
metadata,
delete,
admin
expires_in_days
integer | null

Days until the key expires. Omit or pass null for no expiry.

Required range: 1 <= x <= 365
metadata
object

Arbitrary key-value metadata.

Response

API key created. The api_key field contains the full key — it will not be shown again.

status
enum<string>
Available options:
SUCCESS
message
string
data
object
timestamp
string<date-time>