Skip to main content
POST
Enable a provider
Enables one provider, and its records in every capability domain whose chain names it, so it resolves there again. A record in a domain whose chain does not name the provider stays off. Enabling an enabled provider answers changed: false and records nothing.

Authority and retries

Requires platform:manage at the platform scope. Capability and provider configuration is deployment-wide, so a credential granted platform:manage only at an org unit is refused with 403 and nothing is written. A Forge agent can never hold platform:manage. The write is recorded in the audit log under the calling key or External App, never a person. Send an Idempotency-Key to make a retry safe. The same key and the same body within 24 hours return the recorded 200 only while you still hold platform:manage at the platform scope; otherwise the answer is 409 idempotency_result_unavailable, and the write never runs twice. The same key with a different body is 422.

Errors

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

providerKey
string
required

The provider key, as listProviders returns it (e.g. slack)

Minimum string length: 1

Response

Enable a provider

data
object
required

A provider after the write: whether it is enabled, and whether the write changed its enabled state or options.

meta
object
required