# Restore

> Resource Restore in pulumi-portainer.

<!-- Generated from the pulumi-portainer SDK. -->

Resource Restore in pulumi-portainer.

Pulumi type: `portainer:index/restore:Restore`.

`name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as portainer from "pulumi-portainer"

const resource = new portainer.Restore("restore", {
  fileContentBase64: "<fileContentBase64>",
})
```

## Arguments

| Property            | Type     | Required | Description                                                                                                                                                                                         |
| ------------------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fileContentBase64` | `string` | yes      | Base64-encoded content of the backup archive, typically `filebase64("portainer-backup.tar.gz")`. A backup contains every credential Portainer holds, so it is stored in state as a sensitive value. |
| `fileName`          | `string` | no       | Name reported to Portainer for the uploaded archive.                                                                                                                                                |
| `password`          | `string` | no       | Password the backup was encrypted with. Leave unset for an unencrypted backup.                                                                                                                      |
| `restoreId`         | `string` | no       |                                                                                                                                                                                                     |
| `setupToken`        | `string` | no       | Value sent as the `X-Setup-Token` header. Portainer requires it when the instance has not been initialised yet, which is the usual state for a restore.                                             |

## Outputs

Computed outputs are produced by the provider. They are not constructor arguments.

| Property            | Type     | Computed | Description                                                                                                                                                                                         |
| ------------------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fileContentBase64` | `string` | no       | Base64-encoded content of the backup archive, typically `filebase64("portainer-backup.tar.gz")`. A backup contains every credential Portainer holds, so it is stored in state as a sensitive value. |
| `fileName`          | `string` | no       | Name reported to Portainer for the uploaded archive.                                                                                                                                                |
| `password`          | `string` | no       | Password the backup was encrypted with. Leave unset for an unencrypted backup.                                                                                                                      |
| `restoreId`         | `string` | no       |                                                                                                                                                                                                     |
| `setupToken`        | `string` | no       | Value sent as the `X-Setup-Token` header. Portainer requires it when the instance has not been initialised yet, which is the usual state for a restore.                                             |