ApiKeyCreate

Fields

5 fields

expires_days

integer or null

name · required

string

project_id

string (uuid) or null

Bind key to a single project (ADMIN only)

scopes

array of string

target_user_id

string (uuid) or null

Create key for another user (ADMIN only)

Raw schema (JSON)

{
  "properties": {
    "expires_days": {
      "anyOf": [
        {
          "maximum": 365,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expires Days"
    },
    "name": {
      "maxLength": 100,
      "minLength": 2,
      "title": "Name",
      "type": "string"
    },
    "project_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Bind key to a single project (ADMIN only)",
      "title": "Project Id"
    },
    "scopes": {
      "items": {
        "type": "string"
      },
      "title": "Scopes",
      "type": "array"
    },
    "target_user_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Create key for another user (ADMIN only)",
      "title": "Target User Id"
    }
  },
  "required": [
    "name"
  ],
  "title": "ApiKeyCreate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/keys — Create Api Key

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON