PATCH
/
provisioning
/
organizations
/
{organization_id}
/
connections
/
{connection_id}
Update Connection by ID and Organization ID
curl --request PATCH \
  --url https://api.leen.dev/v1/provisioning/organizations/{organization_id}/connections/{connection_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "credentials": "<any>",
  "identifier": "<string>",
  "state": "PENDING"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor": "<string>",
  "is_active": true,
  "refresh_interval_secs": 123,
  "timeout_secs": 123,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "oauth2_authorize_url": "<string>",
  "identifier": "<string>",
  "state": "PENDING",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "health": {
    "name": "HEALTHY",
    "status": "HEALTHY",
    "description": "<string>",
    "resolution_owner": "LEEN",
    "details": [
      {
        "data_export_type": "alerts",
        "endpoint": "<string>"
      }
    ]
  }
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
X-CONNECTION-INVITE-TOKEN
string | null

Path Parameters

​
organization_id
string<uuid>
required
​
connection_id
string<uuid>
required

Body

application/json
​
credentials
object | null

Connection credentials

​
identifier
string | null

An optional identifier for the connection, you can use this to reference the connection in your own system

​
state
enum<string> | null
default:ACTIVE
Available options:
PENDING,
ACTIVE,
PAUSED,
DELETED

Response

Successful Response

​
id
string<uuid>
required
​
vendor
string
required
​
is_active
boolean
required
​
refresh_interval_secs
integer
required
​
timeout_secs
integer
required
​
organization_id
string<uuid>
required
​
state
enum<string>
required
Available options:
PENDING,
ACTIVE,
PAUSED,
DELETED
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
health
object
required
​
oauth2_authorize_url
string | null
​
identifier
string | null