Gets a Connection by id

GET 
/workspace/:ws_id/connections/:id

Gets a Connection by id

Request

Path Parameters

id stringrequired

ID

ws_id stringrequired

workspace ID

Responses

200

ok

application/json

Schema

Schema

• Array [
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
• ]

Example (from schema)

[
  {
    "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",
    "external_id": "string",
    "full_name": "string",
    "id": "string",
    "name": "string",
    "secret_manager": "string",
    "status": "string",
    "tags": [
      "string"
    ],
    "tenant_id": "string",
    "updated_at": 0,
    "updated_by": "string",
    "workspace_id": "string"
  }
]

404

Cannot find Connection

application/json

Schema

Schema

data
details string
identifier string
message string
status integer
user_error

Example (from schema)

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

Loading...