Skip to content
Open the portal
Developer docs

Create Connector

POST
/v1/connectors
curl --request POST \
--url https://example.com/v1/connectors \
--header 'Content-Type: application/json' \
--data '{ "kind": "example", "name": "example", "config": {}, "secret_ref": "example", "schedule_seconds": 300, "enabled": true }'
Media typeapplication/json
ConnectorIn
object
kind
required
Kind
string
name
required
Name
string
>= 1 characters <= 128 characters
config
Config
object
key
additional properties
any
secret_ref
Any of:
string
schedule_seconds
Schedule Seconds
integer
default: 300 >= 30 <= 86400
enabled
Enabled
boolean
default: true

Successful Response

Media typeapplication/json
Response Create Connector V1 Connectors Post
object
key
additional properties
any
Examplegenerated
{}

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": {}
}
]
}