Generate file restore passcode

Generates a new passcode to access restored files shared by email. A passcode is automatically generated when you share restored files by email. Only regenerate a passcode if you (or the recipient) have lost the original passcode. When you regenerate a new passcode, the old one becomes invalid.

Path Parameters

• restored_file_id string required

  Performs the operation on the restored file with the specified ID. Use GET /restores/files to fetch the id value.

Responses

• 200
• default

---

Success

application/api.clumio.restored-files=v1+json

• Schema
• Example (from schema)

---

Schema

• _links object

  URLs to pages related to the resource.

  _self object

  The HATEOAS link to this resource.

  href string

  The URI for the referenced operation.

  templated boolean

  Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  type string

  The HTTP method to be used with the "href" link for the referenced operation.

• passcode string

  The new passcode that has been generated for the restored file. Send the passcode to the email recipient, who must use it to access the restored file.

{
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "passcode": "string"
}

Error

application/json

• Schema
• Example (from schema)

---

Schema

• errors object[]

  A list of errors encountered during runtime.

  error_code uint32

  error_message string

  The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

Loading...