Probe a saved REST API connector

Send a source verification request using the saved connector configuration and credentials.

POST https://api.moi.matrixorigin.cn/v5/connectors/{id}/rest-api/probe

Before you call this API

Prepare a personal access token for the target workspace and the connector operation permissions. See common information for draft files, source endpoints, and environment boundaries.

Request example

curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/$CONNECTOR_ID/rest-api/probe" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

No request body is needed, and a body cannot temporarily override saved configuration. The connector must be active, a REST API source with import purpose, and have an enabled verification endpoint. Success proves only this verification passed, not preview, task creation, or data import. Source HTTP and token endpoints may still be accessed.

Fields

Type

Required

Description

id

string

Required in path

Enabled REST API connector ID supporting import in the current workspace.

Successful response

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "valid": true
  }
}

Field

Type

Description

code

string

OK on success.

msg

string

Response information.

data

object

Result of this action.

data.valid

boolean

true on success, meaning this source probe and configured success conditions passed.

Error response

Handle configuration errors separately from source-execution failures. MOI may wrap a source error as HTTP 502 ErrConnectorRESTRead. The source HTTP status in an error message is not this request’s status. See Errors and environments.

Last updated on