Pterodactyldocs
Admin A P I

Update extension settings

Validates against the extension's declared rules and persists the submitted values. Omitted fields keep their stored values.

PATCH/api/admin/extensions/{extension_id}/settings
AuthorizationBearer <token>

Application API requests require an application API token, or a client API token, that belongs to a root administrator. Admin API requests require a client API token that belongs to a root administrator, and reject application API tokens. Client API requests require a client API token.

In: header

Path Parameters

extension_id*string

The ID of the extension.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/admin/extensions/architecto/settings" \  -H "Content-Type: application/json" \  -d '{    "settings": {      "curseforge_api_key": "cf-key",      "enabled": true,      "result_limit": 25    }  }'
{  "data": {    "registered": true,    "schema": [      {        "input": "curseforge_api_key",        "label": "CurseForge API Key",        "help": "Leave blank to keep the stored key.",        "field": "password",        "options": [          {            "value": "string",            "label": "Recommended"          }        ],        "value": "string"      }    ]  }}