Admin

Create or update a provider app

post/admin/provider-apps

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/admin/provider-apps
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Request body

$schemastring uri

A URL to the JSON Schema for this object.

bot_tokenstring

Bot token. Omit to preserve the encrypted value when updating.

bot_usernamestring

Public Telegram bot username

client_idstring

OAuth client or application ID

client_secretstring

OAuth client secret. Omit to preserve the existing secret when updating.

connection_modestring

Provider connection mode; inferred when omitted

instance_urlstring

Federated provider instance URL

is_activeboolean

Whether this app should be active. Defaults to true.

namestring

Optional provider app display name

providerstring required

Provider key

redirect_uristring

OAuth redirect URI

webhook_secretstring

Webhook verification secret. Omit to preserve the encrypted value when updating.

Example request

{
  "$schema": "https://example.com/api/v1/schemas/SaveProviderAppInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

existedboolean required

Whether an existing provider app row was updated

requires_restartboolean required

Whether the server must restart before adapter changes apply

Example response

{
  "$schema": "https://example.com/api/v1/schemas/SaveProviderAppResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.