Sign in

v1

latestOpenAPI 3.0.12026-07-265879107.5 KB
Connections

Create connection

Creates a new Connection

post/workspace/{ws_id}/connections

Path parameters

ws_idstring required

Workspace ID

Request body

attributesobject
connection_type_idstring
created_with_o_authboolean
creation_methodstring
namestring

Example request

{
  "connection_type_id": "b07920f3-5dbc-44da-b650-bd1a9c1f540c",
  "name": "My GitHub Connection"
}

Response

ok

attributesModelsConnectionAttributes
connection_type_idstring
created_atinteger
created_bystring
created_with_o_authboolean
creation_locationstring
creation_methodstring
descriptionstring
display_namestring
external_idstring

ExternalId mapping to external entity identifier associated with this connection (used on revoke/uninstall events e.g.)

full_namestring
idstring
namestring

Connection names are unique per tenant as they are used in playbook YAML

secret_managerstring
statusstring
tenant_idstring
updated_atinteger
updated_bystring
workspace_idstring