FruxonDocs
ApiKnowledge bases

Takes a source out of the working list without taking anything down.

Hides the source from the source list while retaining its implementation, ownership links, evidence and provenance — it still resolves by id, so a document that cites it can still name it. A managed source's schedule is stopped alongside, because a hidden source that goes on reading is not what anyone means by archived. A linked source archives too: unlike pause, this asserts only that the source has left the operator's working set, which is true whoever owns the runtime.

POST
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/sources/{source}:archive
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:archive"
{
  "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",
  "upgradeAvailable": {
    "from": 0,
    "to": 0,
    "kind": "UNSPECIFIED"
  },
  "openUpgrade": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ownerKind": "UNSPECIFIED",
    "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
    "recipeKey": "string",
    "fromVersion": 0,
    "toVersion": 0,
    "status": "UNSPECIFIED",
    "failedDuring": "UNSPECIFIED",
    "detail": "string",
    "wasActive": true,
    "canRollBack": true,
    "work": {
      "agents": [
        {
          "role": "UNSPECIFIED",
          "agentId": "string",
          "action": "UNSPECIFIED",
          "targetHash": "string"
        }
      ],
      "automation": {
        "triggerId": "b89c9c0a-30c6-475a-b185-93813e22ffcf",
        "action": "UNSPECIFIED",
        "targetHash": "string"
      },
      "drainStageIds": [
        "string"
      ]
    },
    "revisionsBefore": {
      "property1": 0,
      "property2": 0
    },
    "revisionsAfter": {
      "property1": 0,
      "property2": 0
    },
    "created": [
      {
        "kind": "UNSPECIFIED",
        "role": "UNSPECIFIED",
        "resourceId": "string"
      }
    ],
    "requestedBy": "string",
    "createdAt": 0,
    "modifiedAt": 0,
    "appliedAt": 0,
    "confirmedAt": 0,
    "rolledBackAt": 0
  },
  "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
}