Skip to content
Olivares AI docs

Test connectivity for a connector configuration

POST
/v1/console/connectors/test
 
curl --request POST \
  --url https://example.com/v1/console/connectors/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "config": { "additionalProperty": "example" }, "enabled": true, "kind": "example", "name": "example", "poll_seconds": 1, "secrets": { "additionalProperty": "example" }, "tenant": "example" }'

Tests connectivity for a candidate connector configuration without persisting it.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
config
object
key
additional properties
string
enabled
boolean
kind
required
string
name
required
string
poll_seconds
integer
secrets
object
key
additional properties
string
tenant
required
string
Example generated
{
  "config": {
    "additionalProperty": "example"
  },
  "enabled": true,
  "kind": "example",
  "name": "example",
  "poll_seconds": 1,
  "secrets": {
    "additionalProperty": "example"
  },
  "tenant": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
message
string
success
boolean
Example generated
{
  "message": "example",
  "success": true
}

400

Section titled “400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Section titled “409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Section titled “429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}