API Reference

Create a connection

post
https://api.instill-ai.com/v1beta/namespaces//connections

Creates a connection under the ownership of a namespace.

Path Params
string
required

ID of the namespace that owns the connection.

Body Params

Properties of the connection to be created.

string
required

ID.

string
required

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

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
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

Updated 9 months ago

Language
Credentials
Header
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago