Vault

Retrieve vault connection

Returns the details of a single connection. Scoped automatically to your credential — you'll only see connections you have access to.

get/v1/vault/connections/{id}

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/vault/connections/{id}
  • Auth: one of:
    • API key in header X-One-Secret
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: user:connections:read)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: org:connections:read)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: project:connections:read)

Path parameters

idstring uuid required

Connection ID

Headers

X-One-Organization-Idstring uuid

Selects the tenant this request acts in. Omit it to act in your personal scope.

X-One-Project-Idstring uuid

Selects the tenant this request acts in. Omit it to act in your personal scope.

Response

Vault connection details

activeboolean required
connectorstring required

The connector behind this connection. Carried because a grant bounded by connectors decides on it, so a caller rendering what a token may do here would otherwise have to resolve it by a second lookup per row.

descriptionstring required
environment'test' | 'live' required
idstring uuid required
identitystring nullable
identityType'organization' | 'user' | 'team' | 'project'
imagestring required
keystring required
namestring nullable
platformstring required
platformVersionstring required
state'operational' | 'degraded' | 'failed' | 'unknown' required
tagsstring[] required
titlestring nullable
type'api' | 'databasesql' | 'databasenosql' | 'filesystem' | 'stream' | 'custom' required
versionstring required

Changes

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