dots.v2.actionGateway.connections.post()
Generated on 5 Nov 2026
from DoTs version
v1.23.0
Usage
client.v2.actionGateway.connections.post(body: Connection_create, requestConfiguration?: RequestConfiguration<object>): Promise<undefined | Connection_response>Description
Connects one of your users, identified by user_id, to a provider so tools can act on their
account. An OAuth connection starts pending, and authorization carries the URL to send the user to;
read the connection until it is active or expired. A connection through a team API-key credential is
active immediately. Register the API key with POST /v2/action-gateway/provider-credentials
first, then set credential.team_credential.credential_id to the returned credential.id.
There is one connection per provider and user_id for each DigitalOcean user who creates
connections. Repeating the request returns the existing connection when its scopes cover the
request, reusing a pending connection’s link, and restarts an expired or revoked connection under
the same ID. Requesting scopes beyond an existing connection’s, or a different credential, returns
400 until that connection is deleted.
Parameters
providerstring requiredExample:
jiraRequired provider slug, from the provider list.
userIdstring requiredExample:
aliceRequired. Your identifier for the user the connection acts for: 1 to 64 characters from
[A-Za-z0-9._-]. A session whoseactor_idequals it uses this connection.scopesarray of strings optionalExample:
["write:jira-work"]Optional OAuth scopes to request. Defaults to every scope the provider offers; scopes outside that set are rejected. Ignored for API-key credentials.
connectionParametersobject optionalExample:
{"site_url": "https://example.atlassian.net"}Values for the provider's
connection_parameters, validated against their specifications.credentialobject optionalOptional credential to connect through. Omitted uses DigitalOcean's shared OAuth application.
Show child properties
digitaloceanOauthobject optionalUse DigitalOcean's shared OAuth application.
teamCredentialobject optionalUse one of your team's provider credentials.
networkobject optionalOptional private network for the connection's calls. Requires VPC networking to be enabled for your account (403 otherwise).
Show child properties
vpcobject optionalRoute through a VPC.
Response Example
More Information
See /v2/action-gateway/connections in the API reference for additional detail on responses, headers, parameters, and more.