Update a connection

patch

https://api.instill-ai.com/v1beta/namespaces/{namespaceId}/connections/{connectionId}

Updates a connection with the supplied connection fields.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

namespaceId

string

required

ID of the namespace that owns the connection.

connectionId

string

required

ID of the connection to be updated, as present in the database.

Body Params

Connection object with the new properties to be updated. Immutable and
output-only fields will be ignored. The Setup property must be updated
in block (no partial update is supported).

Connection contains the parameters to communicate with a 3rd party app. A
component may reference a connection in their setup. One connection may be
used by several components and pipelines.

string

required

ID.

integrationId

string

required

Integration ID. It determines for which type of components can reference
this connection.

method

string

enum

required

Method defines how the connection is set up.

METHOD_DICTIONARY: Key-value collection. The user is responsible of fetching the connection
details from the 3rd party service.
METHOD_OAUTH: Access token created via OAuth 2.0 authorization.

Allowed:

setup

object

required

Connection details. This field is required on creation, optional on view.
When viewing the connection details, the setup values will be redacted.

scopes

array of strings

A list of scopes that identify the resources that the connection will be
able to access on the user's behalf. This is typically passed on creation
when the setup has been generated through an OAuth flow with a limited set
of scopes.

scopes

identity

string

When the connection method is METHOD_OAUTH, this field will hold the
identity (e.g., email, username) with which the access token has been
generated.

oAuthAccessDetails

object

When the connection method is METHOD_OAUTH, the access token might come
with some extra information that might vary across vendors. This
information is passed as connection metadata.

Responses

200A successful response.

401Returned when the client credentials are not valid.

defaultAn unexpected error response.