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": "s3", "config": {}, "credentials": {} }'

• Production

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

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

Request Body^required

Media typeapplication/json

object

provider

required

Any platform provider id, e.g. s3, supabase, redshift, aurora, google-analytics. Same config and credentials shape as create.

string

Example

s3

config

object

credentials

required

object

Responses

200

Credentials verified

Media typeapplication/json

object

ok

boolean

Example^generated

{
  "ok": true
}

400

Invalid request

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

403

Access denied

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}