Restore Document

Restore Document

Restores a specific completed document from the DOC Vault Trash back to the DOC Vault completed documents list. Use this endpoint to recover documents that were previously deleted but are still available in the trash.


HTTP Method and URL

PUT {{host}}/api/v2/vault/item/:uuid/restore?user_type=ENTERPRISE_API


Authentication Requirements

Requires a valid authentication token. Typically provided as a header:

Authorization: Bearer {USER-TOKEN}

Path and Query Parameters

Path Parameters:

  • uuid (string): The UUID of the document to restore. Example: {{project-uuid}}

Query Parameters:

  • user_type (string): Specifies the type of user. Example: ENTERPRISE_API

Example Request

PUT {{host}}/api/v2/vault/item/{{project-uuid}}/restore?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}

Example Successful Response

{
  "status": "success",
  "message": "Document restored successfully."
}

Error Responses

  • 401 Unauthorized: Authentication failed or token is missing/invalid.

  • 404 Not Found: The specified document UUID does not exist in the trash.


Usage Notes

  • No request body is required for this endpoint.

  • Ensure the uuid provided belongs to a document currently in the trash; otherwise, a 404 error will be returned.

  • Only users with appropriate permissions can restore documents.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string
Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!