Trigger manual data sync

POST

/api/v1/connectors/{connector_id}/sync

curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/connectors/example/sync \
  --header 'X-API-Key: <X-API-Key>'

• Production
• Local development

Enqueues an asynchronous data sync for the connector instance. Returns 202 Accepted immediately.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

connector_id

required

Connector Id

string

Responses

202

Successful Response

Media typeapplication/json

SyncResponse

Response for POST /connectors/{id}/sync.

Attributes: connector_id: Instance identifier. sync_status: Always ‘queued’ (async operation).

object

connector_id

required

Connector Id

string

sync_status

required

Sync Status

string

Example^generated

{
  "connector_id": "example",
  "sync_status": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}