Connections

Create Connection

Changed on

Create connection metadata and optionally store encrypted credentials.

post/api/v1/connections

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Request body

allow_non_interactiveboolean
display_namestring required
granted_scopesstring[]
namestring required
ownership_mode'user' | 'instance'
provider_keystring required

Response

Successful Response

allow_non_interactiveboolean required
created_atstring date-time required
display_namestring required
granted_scopesstring[] required
has_credentialsboolean required
health'unknown' | 'healthy' | 'unhealthy' required
health_checked_atstring date-time nullable required
idstring uuid required
namestring required
owner_idstring uuid nullable required
ownership_mode'user' | 'instance' required
provider_keystring required
status'pending' | 'ready' | 'expired' | 'revoked' | 'error' required
status_reason'credential-missing' | 'credential-undecryptable' | 'oauth-denied' | 'oauth-expired' | 'oauth-failed'

A credential error or the result of the most recent failed OAuth attempt.

updated_atstring date-time required

Changes