FruxonDocs
ApiKnowledge bases

Upgrades a knowledge base's own consolidator and editor to the current recipe, as previewed.

The plan is recomputed and must hash to the previewed `planHash` (409 otherwise). A background job waits for any consolidation pass in progress, deploys a new revision of each changed agent, and records the new version on the base last. While it is under way the base refuses reconfiguring, disabling and deleting its consolidation.

POST
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}:upgrade

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
tenant*string

The tenant identifier

Request Body

The plan hash of the preview being confirmed.

planHash?string

The planHash of the preview being confirmed. When what the upgrade would write has moved since — an agent redeployed, the automation edited, a newer server's recipe — it no longer matches, and the upgrade is refused with 409 rather than applied unseen.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08:upgrade" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "ownerKind": "KNOWLEDGE_SOURCE",
  "ownerId": "00000000-0000-0000-0000-000000000000",
  "recipeKey": "string",
  "fromVersion": 0,
  "toVersion": 0,
  "status": "PLANNED",
  "failedDuring": "PLANNED",
  "detail": "string",
  "wasActive": false,
  "canRollBack": false,
  "work": {
    "agents": [
      {
        "role": "UNSPECIFIED",
        "agentId": "string",
        "action": "UNSPECIFIED",
        "targetHash": "string"
      }
    ],
    "automation": {
      "triggerId": "00000000-0000-0000-0000-000000000000",
      "action": "UNCHANGED",
      "targetHash": "string"
    },
    "drainStageIds": [
      "string"
    ]
  },
  "revisionsBefore": {},
  "revisionsAfter": {},
  "created": [
    {
      "kind": "TRIGGER",
      "role": "SOURCE",
      "resourceId": "string"
    }
  ],
  "requestedBy": "string",
  "createdAt": 0,
  "modifiedAt": 0,
  "appliedAt": 0,
  "confirmedAt": 0,
  "rolledBackAt": 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
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}