Skip to main content

Create connection

POST 
/workspace/:ws_id/connections

Creates a new Connection

Request​

Path Parameters

    ws_id stringrequired

    Workspace ID

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​

ok

Schema
    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
    external_id string

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

    full_name string
    id string
    name string

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

    secret_manager string
    status string
    tags string[]
    tenant_id string
    updated_at integer
    updated_by string
    workspace_id string
Loading...