Skip to content

Test connector credentials (no save)

POST
/v1/workspaces/{workspaceId}/connections/test
curl --request POST \
--url https://shareout.site/v1/workspaces/example/connections/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "provider": "google-analytics", "config": {}, "credentials": {} }'

Admin+. Runs the provider’s verifyConnection probe on unsaved credentials before creating a connector.

workspaceId
required
string

Workspace ID or slug.

Media type application/json
object
provider
required
string
Example
google-analytics
config
object
credentials
required
object

Credentials verified

Media type application/json
object
ok
boolean
Example generated
{
"ok": true
}

Invalid request

Media type application/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
Example
{
"success": false
}

Access denied

Media type application/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
Example
{
"success": false
}