Skip to main content
POST
/
connectors
/
ping
Ping a connector
curl --request POST \
  --url https://api.artie.com/connectors/ping \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataPlaneName": "<string>",
  "defaultDatabase": "<string>",
  "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "sharedConfig": {},
  "sshTunnelUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "uuid": "<string>"
}
'
{
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://artie.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Body

application/json
​
dataPlaneName
string
​
defaultDatabase
string | null
​
environmentUUID
string<uuid> | null
​
label
string
​
sharedConfig
object
​
sshTunnelUUID
string<uuid> | null
​
type
string
​
uuid
string

Response

OK

​
error
string