Update an existing connection by ID

patch

https://api.spartera.com/companies/{company_id}/connections/{connection_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

length between 1 and 255

^[a-zA-Z0-9_-]+$

Unique identifier for the Company

connection_id

string

required

length between 1 and 255

^[a-zA-Z0-9_-]+$

Unique identifier for the Connection

Body Params

Update schema for modifying Connection

user_id

string

References users.user_id — An individual user account within a company. See GET /users for valid values. Optional.

engine_id

int64

References storage_engines.engine_id — Fact table of all the different storage engines we support. See GET /storage_engines for valid values. Required.

company_id

string

References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required.

credential_type

string

enum

Optional. One of: SERVICE_ACCOUNT, USERNAME_PASSWORD, API_KEY, SERVICE_IDENTITY, ACCESS_KEY, … (10 total).

name

string

Optional.

description

string

Optional.

provider_domain

string

Domain of the external API provider (e.g., 'api.weather.com')

verified_usage_ability

boolean

Optional.

Responses

200Successfully updated connections

400Invalid input

401Authentication required

403Permission denied

404Resource not found

409Resource conflict (duplicate, constraint violation)

422Request well-formed but semantically invalid

429Rate limit exceeded

500Internal server error