Synchronization

Api Sync Providers

get

Responses

200

Successful Response

application/json

Responseany

get

/api/sync/providers

HTTPcURLJavaScriptPython

GET /api/sync/providers HTTP/1.1
Accept: */*

200

Successful Response

No content

Api Pairs List

get

Responses

200

Successful Response

application/json

Responseany

get

/api/pairs

HTTPcURLJavaScriptPython

GET /api/pairs HTTP/1.1
Accept: */*

200

Successful Response

No content

Api Pairs Add

post

Body

application/json

sourcestringRequired

targetstringRequired

modeany ofOptional

stringOptional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

featuresany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/pairs

HTTPcURLJavaScriptPython

POST /api/pairs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "source": "text",
  "target": "text",
  "mode": "text",
  "enabled": true,
  "features": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Api Pairs Reorder

post

Bodystring[]

application/json

string[]Optional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/pairs/reorder

HTTPcURLJavaScriptPython

POST /api/pairs/reorder HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Api Pairs Update

put

Path parameters

pair_idstringRequired

Body

application/json

sourceany ofOptional

stringOptional

or

nullOptional

targetany ofOptional

stringOptional

or

nullOptional

modeany ofOptional

stringOptional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

featuresany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/api/pairs/{pair_id}

HTTPcURLJavaScriptPython

PUT /api/pairs/{pair_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "source": "text",
  "target": "text",
  "mode": "text",
  "enabled": true,
  "features": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Api Pairs Delete

delete

Path parameters

pair_idstringRequired

Query parameters

purge_statebooleanOptionalDefault: true

Responses

200

Successful Response

application/json

422

Validation Error

application/json

delete

/api/pairs/{pair_id}

HTTPcURLJavaScriptPython

DELETE /api/pairs/{pair_id} HTTP/1.1
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Api Provider Counts

get

Query parameters

max_ageintegerOptionalDefault: 30

forcebooleanOptionalDefault: false

sourcestringOptionalDefault: state

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/sync/providers/counts

HTTPcURLJavaScriptPython

GET /api/sync/providers/counts HTTP/1.1
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Api Run Sync

post

Body

application/json

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/run

HTTPcURLJavaScriptPython

POST /api/run HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Api Run Summary

get

Responses

200

Successful Response

application/json

Responseany

get

/api/run/summary

HTTPcURLJavaScriptPython

GET /api/run/summary HTTP/1.1
Accept: */*

200

Successful Response

No content

Api Run Summary File

get

Responses

200

Successful Response

application/json

Responseany

get

/api/run/summary/file

HTTPcURLJavaScriptPython

GET /api/run/summary/file HTTP/1.1
Accept: */*

200

Successful Response

No content

Api Run Summary Stream

get

Responses

200

Successful Response

application/json

Responseany

get

/api/run/summary/stream

HTTPcURLJavaScriptPython

GET /api/run/summary/stream HTTP/1.1
Accept: */*

200

Successful Response

No content