--- title: "Restore several deleted records" method: POST path: "/knowledgeBase/records/restore" tags: ["Knowledge Base"] --- # Restore several deleted records `POST /knowledgeBase/records/restore` ## Request - Base URL: `https://app.pipeshub.com/api/v1` - URL: `https://app.pipeshub.com/api/v1/knowledgeBase/records/restore` - Auth: one of: - HTTP bearer - OAuth 2 - Authorization code: `/api/v1/oauth2/authorize` - Client credentials - Token URL: `/api/v1/oauth2/token` scopes: `kb:delete` Restore up to 100 records from the trash. Each id is restored as `POST /knowledgeBase/record/{recordId}/restore` restores it, with everything deleted along with it; ids from one delete are restored once. Every id gets its own outcome in `results`, so one refusal does not hold the others back, and the answer is 200 whatever the outcomes: with the trash turned off in Labs every id is refused with `code: 403` inside a 200. An id listed twice is answered once. Body fields other than `recordIds` are ignored. ## Request body - RestoreRecordsRequestBody: Request body for POST /knowledgeBase/records/restore. Fields other than `recordIds` are dropped by the validator, not refused. - `recordIds` string[], required: Record ids to restore. An id listed more than once is restored, and answered, once. ## Response `200` Outcome for each requested record - RestoreRecordsResponseSchema: Response returned by POST /knowledgeBase/records/restore. - `success` boolean, required: True when every requested record was restored - `restoredCount` integer, required: Records restored, counting those restored along with them - `failedCount` integer, required - `results` RestoreRecordsResultItemSchema[], required: One entry per requested id: `recordId`, `success`, `code`, and either the restore response fields or a `reason` that says what to do next. - `recordId` string, required - `success` boolean, required - `code` integer: The status the single restore would have answered (200, 403, 404, 409) - `reason` string: Why it was not restored, and what to do next - `message` string: Present on success - `batchId` string, nullable: The delete batch that was restored; `null` when the record was not in the trash - `restoredRecords` RestoredRecordSchema[]: Present on success; empty when the record was not in the trash - `recordId` string, required - `name` string, nullable: The name it has now - `renamedFrom` string: Its name before restore, when another item next to it had taken that name - `reindexPending` boolean: Some restored files could not be queued for indexing - `reindexPendingRecordIds` string[]: Files to reindex by hand to make them searchable again - `reindexPendingReason` string - `renamePendingRecordIds` string[]: Items restored under a name another item next to them has; rename them - `renamePendingReason` string - `blockedRecordId` string: The item a refusal is about - `external_id` string: The source item two of the restored items came from - `conflicting_record_id` string: The live item that holds this item's place - `conflicting_record_name` string, nullable - `missing` string[]: Items of the batch that were no longer in the trash - `parentId` string, nullable: The folder still in the trash that must be restored first ## Other responses - `400`: recordIds is missing, not a list, empty, or longer than 100, or one of the ids is not a string or is empty after trimming. Send between 1 and 100 record ids. Also returned, before authentication, when a query value, or any string in a JSON or form-encoded body, looks like markup to the app-wide XSS filter: an HTML tag, a script tag, `