Error
A valid request URL is required to generate request examples{
"result": "success",
"message": "<string>",
"tested_at": "2023-11-07T05:31:56Z",
"error_code": "<string>",
"provider_id": "<string>",
"item_name": "<string>"
}{
"code": 123,
"message": "<string>",
"error": "<string>",
"error_code": "INVALID_REFERENCE",
"provider_id": "<string>",
"item_name": "<string>"
}Reset cached metadata for a connection
POST
/
v2
/
connections
/
{connection_id}
/
reset-metadata
Error
A valid request URL is required to generate request examples{
"result": "success",
"message": "<string>",
"tested_at": "2023-11-07T05:31:56Z",
"error_code": "<string>",
"provider_id": "<string>",
"item_name": "<string>"
}{
"code": 123,
"message": "<string>",
"error": "<string>",
"error_code": "INVALID_REFERENCE",
"provider_id": "<string>",
"item_name": "<string>"
}Authorizations
ApiKeyAuthBasicAuth
A Sync user auth token. Generate one via POST /v2/users/generate-token.
Path Parameters
Connection identifier.
Response
Operation result
Result of a connection test, credential reset, or metadata reset. Operation failures, including Vault resolution failures, return HTTP 200 with result=error and a message. Vault failures also include optional diagnostic fields without exposing resolved values. Errors handled outside the operation catch, such as request validation, role validation, and resource lookup, retain their existing non-2xx responses.
Available options:
success, error Present on connection test.
Present when the operation fails to resolve a Vault reference.
Vault provider identifier, when available.
Referenced Vault item name, when available; never its value.