Register a write-only API credential

post/v1/connections

Request

  • Base URL: https://api.looot.ai
  • URL: https://api.looot.ai/v1/connections
  • Auth: HTTP bearer

Request body

kind'api_key' | 'oauth' | 'service_account' | 'credential_file' | 'signed_request' | 'cli_auth'
idstring required
providerIdstring required
labelstring required
placement'header' | 'query'
namestring
formatstring

e.g. "Bearer {secret}"

secretstring
authorizationUrlstring uri
tokenUrlstring uri
scopesstring[]
tokenPlacement'header' | 'query'
clientIdstring
keyFilestring
filestring
keyIdstring
algorithm'hmac-sha256'
signedHeadersstring[]
blobstring
credentialExpiresAtstring date-time nullable
secondaryCredentialRolesstring[]

Secondary credential roles this provider requires beyond the primary auth

Response

Connection metadata; secrets and internal references are excluded

idstring required
providerIdstring required
labelstring required
status'draft' | 'authorization_pending' | 'connected' | 'degraded' | 'expired' | 'action_required' | 'revoked' required
scopesstring[] required

Granted scopes, populated after oauth callback or a probe that reports scopes

cooldownUntilstring date-time nullable required
credentialExpiresAtstring date-time nullable required
pendingCredentialRolesstring[] required

Declared secondary credential roles not yet supplied; non-empty implies status action_required

createdAtstring date-time required
updatedAtstring date-time required
testState'not_tested' | 'verified' required

verified requires at least one persisted fixture_tested receipt; never set from CRUD alone

probeConfiguredboolean

true when POST /v1/connections/{connectionId}/probe has a live health check to run; false for a pasted api_key with no probe (the probe then answers 400 validation_error with reason connection_probe_not_configured)

Changes

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