integrations

Test Connection

Test client credentials connection for the specified provider.

post/workspaces/{workspace_id}/integrations/{provider_id}/test

Request

  • Base URL
    https://platform.tracecat.com/api
  • Auth
    • API key in cookie fastapiusersauth
    • or HTTP bearer

Path parameters

workspace_idstring uuid required
provider_idstring required

Response

Successful Response

successboolean required

Whether the connection test was successful

provider_idstring required

The provider that was tested

messagestring required

Message describing the test result

errorstring nullable

Error message if the test failed

Changes

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