Sign in
toolkits

Update toolkit — rename or update description

Update toolkit metadata — name, description, disabled state, or simulation mode.

Only changed fields need to be included in the request body. Omitted fields are left unchanged.

Note: The default toolkit's name and description cannot be modified (403 error).

Auth: Requires human session (admin).

patch/toolkits/{toolkit_id}

Path parameters

toolkit_idstring required

Toolkit ID to update

Toolkit ID to update

Request body

namestring nullable

New toolkit name (optional)

descriptionstring nullable

New description (optional)

simulateboolean nullable

Toggle dry-run mode (optional)

disabledboolean nullable

Toggle toolkit disabled state (optional)

Response

Successful Response

idstring required

Toolkit ID

namestring required

Human-readable toolkit name

descriptionstring nullable

Optional description of this toolkit's purpose

created_atnumber nullable

Unix timestamp when created

disabledboolean

If true, all API keys for this toolkit are revoked

key_countinteger nullable

Number of API keys issued for this toolkit

credential_countinteger nullable

Number of credentials bound to this toolkit

permissionsobject[]

Access control rules for this toolkit

Example response

{
  "id": "default",
  "name": "Default Toolkit",
  "description": "Default toolkit for general-purpose API access",
  "created_at": 1672531200,
  "key_count": 3,
  "credential_count": 5,
  "keys": [],
  "credentials": [],
  "permissions": [
    {
      "effect": "allow",
      "methods": [
        "GET"
      ]
    }
  ]
}

Changes