Skip to main content
PUT
/
dc
/
sources
/
{source_pid}
/
status
Manage Source
curl --request PUT \
  --url https://ds.cominty.com/dc/sources/{source_pid}/status \
  --header 'x-cominty-token: <api-key>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "id": 123,
  "pid": "<string>",
  "name": "<string>",
  "scope": "<string>",
  "created_by": "<string>",
  "store": "<string>",
  "status": "<string>",
  "size": 123,
  "embedded_size": 123,
  "config": {},
  "documents_synced": 123,
  "documents_failed": 123,
  "oversized_documents": 123,
  "documents_embedded": 123,
  "last_synced_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "connection": {
    "id": "<string>",
    "name": "<string>",
    "status": "<string>",
    "created_by": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "checked_at": "2023-11-07T05:31:56Z",
    "inoperative": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cominty.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-cominty-token
string
header
required

Your Cominty API token.

Path Parameters

​
source_pid
string
required

Query Parameters

​
operation
enum<string>
required
Available options:
start,
pause,
archive,
sync

Response

Successful Response

​
created_at
string<date-time>
required
​
id
integer
required
​
pid
string
required
​
name
string
required
​
scope
string
required
​
created_by
string
required
​
store
string
required
​
status
string
required
​
size
integer
required
​
embedded_size
integer
required
​
config
Config · object
required
​
documents_synced
integer
required
​
documents_failed
integer
required
​
oversized_documents
integer
required
​
documents_embedded
integer
required
​
last_synced_at
string<date-time> | null
required
​
archived_at
string<date-time> | null
required
​
connection
ConnectionOut · object
required