TRtracecat
providers

Create Custom Provider

post/workspaces/{workspace_id}/providers

Request

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

Path parameters

workspace_idstring uuid required

Request body

namestring required
descriptionstring nullable
grant_type'authorization_code' | 'client_credentials' required

Grant type for OAuth 2.0.

authorization_endpointstring required

OAuth authorization endpoint URL

token_endpointstring required

OAuth token endpoint URL

scopesstring[] nullable

Default OAuth scopes to request

provider_idstring nullable

Optional custom identifier for the provider

client_idstring required

OAuth client identifier

client_secretstring password nullable

OAuth client secret for the provider

Response

Successful Response

idstring required
namestring required
descriptionstring required
requires_configboolean required
integration_status'not_configured' | 'configured' | 'connected' | 'reauth_required' required

Status of an integration.

enabledboolean required
grant_type'authorization_code' | 'client_credentials' required

Grant type for OAuth 2.0.

Changes

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