Test a context connection's stored credentials

Verifies the stored credentials of a context connection against the external service, without changing anything. A failed verification is reported in the response body with success set to false rather than as an HTTP error. Connectors that have nothing to verify report success: true.

post

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

siteContextConnectionIdstringRequired

The unique id of the context connection

Responses

200

The connection test completed (see success for the outcome).

application/json

objectstring · enumRequiredPossible values:

successbooleanRequired

Whether the stored credentials authenticated successfully.

errorstringOptional

A human-readable reason for the failure, when the test failed.

post/orgs/{organizationId}/sites/{siteId}/context-connections/{siteContextConnectionId}/test

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/sites/{siteId}/context-connections/{siteContextConnectionId}/test HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The connection test completed (see success for the outcome).

{
  "object": "context-connection-test-result",
  "success": true,
  "error": "text"
}