FruxonDocs
ApiKnowledge bases

Stops a managed source from reading anything further.

Deactivates the managed automation's schedule and records the source as paused. Work already claimed runs to its own boundary; what pausing withholds is the next pass. Repeating the call is safe and re-asserts both halves, so a source whose automation was left running is corrected rather than reported as already paused. A source with a user-owned implementation is refused: Knowledge never changes one, and pausing its automation is where that is done.

POST
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/sources/{source}:pause

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

knowledgeBase*string

The knowledge base id.

Formatuuid
source*string

The knowledge source id.

Formatuuid
tenant*string

The tenant identifier

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08:pause"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "knowledgeBaseId": "619a59ff-6d34-4e0c-9a58-4d2cf062eac9",
  "displayName": "string",
  "kind": "UNSPECIFIED",
  "status": "UNSPECIFIED",
  "managementMode": "UNSPECIFIED",
  "recipeKey": "string",
  "recipeVersion": 0,
  "config": null,
  "approvalPolicy": "UNSPECIFIED",
  "approvalSamplePercent": 0,
  "publishPolicy": "UNSPECIFIED",
  "settingsEditable": true,
  "settingsNotEditableReason": "string",
  "resources": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "resourceKind": "UNSPECIFIED",
      "resourceId": "string",
      "role": "UNSPECIFIED",
      "ownership": "UNSPECIFIED"
    }
  ],
  "createdAt": 0,
  "modifiedAt": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}