Skip to main content
GET
Read Settings
Auth: TokenAccount or TokenInstanceRate-limit: Global (100/min) • Idempotent: yes

Description

Returns the 7 instance behavior flags: call rejection, ignore groups, keep online, mark as read, history sync, ignore status.

Example

Performs a GET on the instance path and returns the settings object with all current flags. No query params are accepted, only the name in the path and the token in the header.

Success response

200 OK

Path parameters

string
required
Instance name.

Headers

string
required
TokenAccount or TokenInstance.

Fields

Errors

Next

Update settings

POST /api/instance/settings/:instance to change.