POST

/api/v1/tokens

Create an API token; plaintext is returned only in this response

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/tokens" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.

Authentication and permissions#

Authentication: Bearer token

Scopes: admin

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

No path or query parameters declared.

Request body#

Required.

Field	Type	Required
`name`	`string`	Yes
`kind`	`union`	No
`scope_set`	`union`	No
`scopes`	`array`	No
`expires_at`	`integer \| null`	No

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "kind": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "native"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "mcp"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "compat"
                ]
              }
            ]
          },
          "scope_set": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "full"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "scripts"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "mcp"
                ]
              }
            ]
          },
          "scopes": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "profiles:read"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "profiles:write"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "profiles:delete"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "runtime:control"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "proxies:read"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "proxies:write"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "secrets:read"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "secrets:totp"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "cookies:read"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "cookies:write"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "extensions:write"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "kernels:manage"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "trash:manage"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "rpa:run"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "rpa:write"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "sync:control"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "settings:write"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "audit:read"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "admin"
                  ]
                }
              ]
            },
            "minItems": 1,
            "uniqueItems": true
          },
          "expires_at": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

201 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "token",
          "info"
        ],
        "properties": {
          "token": {
            "type": "string"
          },
          "info": {
            "type": "object",
            "required": [
              "id",
              "name",
              "kind",
              "token_hint",
              "scopes",
              "created_at",
              "last_used_at",
              "expires_at",
              "revoked_at"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "kind": {
                "type": "string"
              },
              "token_hint": {
                "type": "string"
              },
              "scopes": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "created_at": {
                "type": "integer"
              },
              "last_used_at": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "expires_at": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "revoked_at": {
                "type": [
                  "null",
                  "integer"
                ]
              }
            }
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "API-Token erzeugen; der Klartext wird nur in dieser Antwort geliefert",
  "tags": [
    "Tokens"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "kind": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "native"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "mcp"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "compat"
                  ]
                }
              ]
            },
            "scope_set": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "full"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "scripts"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "mcp"
                  ]
                }
              ]
            },
            "scopes": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "profiles:read"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "profiles:write"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "profiles:delete"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "runtime:control"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "proxies:read"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "proxies:write"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "secrets:read"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "secrets:totp"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "cookies:read"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "cookies:write"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "extensions:write"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "kernels:manage"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "trash:manage"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "rpa:run"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "rpa:write"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "sync:control"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "settings:write"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "audit:read"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "admin"
                    ]
                  }
                ]
              },
              "minItems": 1,
              "uniqueItems": true
            },
            "expires_at": {
              "type": [
                "integer",
                "null"
              ],
              "minimum": 0
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "token",
              "info"
            ],
            "properties": {
              "token": {
                "type": "string"
              },
              "info": {
                "type": "object",
                "required": [
                  "id",
                  "name",
                  "kind",
                  "token_hint",
                  "scopes",
                  "created_at",
                  "last_used_at",
                  "expires_at",
                  "revoked_at"
                ],
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "kind": {
                    "type": "string"
                  },
                  "token_hint": {
                    "type": "string"
                  },
                  "scopes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "created_at": {
                    "type": "integer"
                  },
                  "last_used_at": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "expires_at": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "revoked_at": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}