Verify whether a source is properly configured

curl --request GET \
  --url https://api.portable.io/v2/sources/{id}/verify \
  --header 'Authorization: Bearer <token>'

{
  "$ref": "#/components/examples/checksFreshsales/value"
}

Sources

Verify whether a source is properly configured

Use this endpoint to validate the properties for the specified source. If any required property is missing, the response includes a relevant error message. If all required properties are present, it attempts to establish a connection with the source’s API servers and returns a status message indicating whether the connection was successful. The response is an array of check messages. Each element includes two fields: isError (a boolean flag) and message (a string). Use the isError field to distinguish between error and informational messages. See the example for more details. This process runs synchronously, so it may take a few seconds to complete. There is also a 10‑second timeout for the whole process.

GET

sources

{id}

verify

Verify whether a source is properly configured

curl --request GET \
  --url https://api.portable.io/v2/sources/{id}/verify \
  --header 'Authorization: Bearer <token>'

{
  "$ref": "#/components/examples/checksFreshsales/value"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer<int>

required

Response

data

object[]

required

Show child attributes

data.message

string

required

The message of the check

data.name

string

The name of the check

data.is_error

boolean

Whether this check failed

Update source List destination specs

⌘I

API Documentation

Source Specs

Sources

Destination Specs

Destinations

Flows

Verify whether a source is properly configured

Authorizations

Path Parameters

Response