Instance

Read the instance branding shown before sign-in

GET /api/v1/instance/branding

Operation

branding.get

Accepts

No credential

Effect

reading

Rate class

read

Parameters

• locale string in query, optional

Answers

• 200 The result

  application/json: ClientBranding

• 400 BAD_REQUEST: The request cannot be read.
• 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
• 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
• 500 INTERNAL: The instance failed. The message never carries details.

Read the instance configuration a member may see

GET /api/v1/instance/config

Operation

config.get

Accepts

sessionCookie, sessionToken

Scope

config:read

Effect

reading

Rate class

read

Parameters

• locale string in query, optional

Answers

• 200 The result

  application/json: SafeConfig

• 400 BAD_REQUEST: The request cannot be read.
• 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
• 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
• 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
• 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
• 500 INTERNAL: The instance failed. The message never carries details.