Skip to content

Upsert Connector Binding

PUT
/v1/connectors/bindings/{connector_id}
curl --request PUT \
--url https://example.com/v1/connectors/bindings/example \
--header 'Content-Type: application/json' \
--data '{ "tenant_id": "example", "proposal_id": "example", "base_url": "example", "client_id": "example", "secret_ref": "example", "enabled": true, "metadata": {} }'
connector_id
required
Connector Id
string
x-api-key
Any of:
string
Media typeapplication/json
ConnectorBindingUpsertIn
object
tenant_id
required
Tenant Id
string
>= 1 characters
proposal_id
required
Proposal Id
string
>= 1 characters
base_url
required
Base Url
string
>= 1 characters
client_id
Any of:
string
secret_ref
Any of:
string
enabled
Enabled
boolean
default: true
metadata
Metadata
object
key
additional properties
any

Successful Response

Media typeapplication/json
ConnectorBindingOut
object
tenant_id
required
Tenant Id
string
id
required
Id
string
connector_id
required
Connector Id
string
base_url
required
Base Url
string
client_id
Any of:
string
secret_ref
Any of:
string
enabled
required
Enabled
boolean
metadata
required
Metadata
object
key
additional properties
any
Examplegenerated
{
"tenant_id": "example",
"id": "example",
"connector_id": "example",
"base_url": "example",
"client_id": "example",
"secret_ref": "example",
"enabled": true,
"metadata": {}
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}