Create connection

POST 
/workspace/:ws_id/connections

Creates a new Connection

Request

Path Parameters

ws_id stringrequired

Workspace ID

application/json

Body

required

Connection Data

attributes object
property name* object
value string
connection_type_id string
created_with_o_auth boolean
creation_method string
name string

Responses

200

ok

application/json

Schema

Schema

active boolean
attributes object
property name* object
value
connection_type_id string
created_at integer
created_by string
created_with_o_auth boolean
creation_location string
creation_method string
description string
display_name string
full_name string
id string
name string

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

secret_manager string
tags string[]
tenant_id string
updated_at integer
updated_by string
workspace_id string

Example (from schema)

{
  "active": true,
  "attributes": {},
  "connection_type_id": "string",
  "created_at": 0,
  "created_by": "string",
  "created_with_o_auth": true,
  "creation_location": "string",
  "creation_method": "string",
  "description": "string",
  "display_name": "string",
  "full_name": "string",
  "id": "string",
  "name": "string",
  "secret_manager": "string",
  "tags": [
    "string"
  ],
  "tenant_id": "string",
  "updated_at": 0,
  "updated_by": "string",
  "workspace_id": "string"
}

400

Cannot create Connection

application/json

Schema

Schema

data
details string
identifier string
message string
status integer

Example (from schema)

{
  "data": {},
  "details": "string",
  "identifier": "string",
  "message": "string",
  "status": 404
}

Loading...