Skip to content

connections_create

POST
/api/connections
curl --request POST \
--url https://example.com/api/connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--data '{ "plugin": "example", "name": "example", "shared_params": { "additionalProperty": "example" }, "private_params": { "additionalProperty": "example" } }'

Create a new Connection object.

X-Workspace
required
string format: uuid

Workspace ID

Document the request body for creating a connection.

The runtime validation is custom (plugin/shared_params/private_params) and does not fully map to ConnectionSerializer fields, so Swagger needs a dedicated request schema.

object
plugin
required
string
name

Name of the connection. When empty, the name is computed by the plugin. Ignored when the connection already exists in the workspace.

string
nullable <= 1000 characters
shared_params
required
object
key
additional properties
private_params
object
key
additional properties

Example generated

{
"plugin": "example",
"name": "example",
"shared_params": {
"additionalProperty": "example"
},
"private_params": {
"additionalProperty": "example"
}
}
Media typeapplication/json

Serializer for handling connection-related data.

object
id
required
string format: uuid
name
required
string
nullable
plugin
string
nullable <= 100 characters
shared_params
required
Array<object>

Serializer for handling connection-related data.

object
key
string
nullable <= 100 characters
value
required
string
plugin_obj
required

Return serialized data for a plugin object based on the plugin class.

Parameters

obj : Connection The object containing information about a plugin.

Returns

dict An instance of the PluginSerializer class with the plugin class obtained from get_plugin_class(obj.plugin) and the context set to include the request from self.context.

object
key
additional properties
credential
required
One of:
object
key
additional properties
created_by
required

Return the interactor information of the object’s creator.

Parameters

obj : Connection The object containing the creator information.

Returns

dict The interactor information of the creator.

object
key
additional properties
created_time
required
string format: date-time
last_edited_time
required

Return the last edited time of an object’s credential for the current user.

string
nullable
workspace
string format: uuid
status
required

Return the status of a credential object associated with a user.

Parameters

obj : Connection The object containing information related to the credential.

Returns

str A string representing the status of the credential. Returns “not_connected” if no credential is found or an empty string in case of an exception.

string
current_tasks
required

Return the current tasks for the current connection.

Array
is_sandbox
required

Determine whether the connection is a sandbox one.

Parameters

obj : Connection The object containing the plugin and shared parameters.

Returns

bool True if the connection uses a sandbox URL, False otherwise.

boolean

Example generated

{
"plugin": "example",
"shared_params": [
{
"key": "example",
"value": "example"
}
],
"workspace": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "plugin_error",
"message": "An error occurred in the plugin. Check the `details` property for more details.",
"details": [
{
"parameter": "connection",
"message": "Custom message from the plugin",
"code": "authentication_failed"
}
]
}