POST
/
workspace
/
{ws_id}
/
connections
curl --request POST \
  --url https://app.blinkops.com/api/v1/workspace/{ws_id}/connections \
  --header 'BLINK-API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "attributes": {},
  "connection_type_id": "b07920f3-5dbc-44da-b650-bd1a9c1f540c",
  "created_with_o_auth": true,
  "creation_method": "<string>",
  "name": "My GitHub Connection"
}'
{
  "attributes": {},
  "connection_type_id": "<string>",
  "created_at": 123,
  "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": 123,
  "updated_by": "<string>",
  "workspace_id": "<string>"
}

Authorizations

​
BLINK-API-KEY
string
header
required

Use your API key to access BlinkOps API. To generate an API key, please log in to your BlinkOps account and navigate to the API Keys section in the user settings page. Add the generated key to your request headers as BLINK-API-KEY.

Path Parameters

​
ws_id
string
required

Workspace ID

Body

application/json
Connection Data
​
attributes
object
​
connection_type_id
string
​
created_with_o_auth
boolean
​
creation_method
string
​
name
string

Response

200
application/json
ok
​
attributes
object
​
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

Was this page helpful?

List connectionsDelete Connection