v12

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01252498556.8 KB

credentials

Validate credentials against their cloud provider and report the outcome

post/credentials/{credentialsId}/validate

Path parameters

credentialsIdstring required

Credentials string identifier

Query parameters

workspaceIdinteger

Workspace numeric identifier

forceboolean

When true, skip the probe and force the credential (INVALID only) to AVAILABLE. Rejected with 409 for any other status.

Response

Validation outcome — inspect status and the transientError flag on the response body

messagestring nullable

Provider-supplied error detail. Null when the credentials are valid.

status'AVAILABLE' | 'INVALID'

transientErrorboolean

True when validation could not reach the provider (network error / 5xx). When true the persisted status is left untouched and MUST NOT be interpreted as an authoritative reject.