# RESTORE

> Deserialize and restore a key.

Use `RESTORE` to recreate a key from a payload produced by [`DUMP`](/redis/commands/generic/dump).

`<ttl>` gives the new key a lifetime in milliseconds, where `0` means no expiration; with `ABSTTL` the same number is read as an absolute Unix timestamp in milliseconds instead. The command fails if the key already exists unless `REPLACE` is given.

The payload's version stamp and checksum are verified before anything is written, so a truncated, corrupted, or foreign payload is rejected rather than loaded. `IDLETIME` and `FREQ` seed the eviction metadata of the new key so that a restored key does not automatically look freshly used.

## Syntax

```redis
RESTORE <key> <ttl> <serialized-value>
  [REPLACE]
  [ABSTTL]
  [IDLETIME <seconds>]
  [FREQ <frequency>]
```

## Arguments

| Argument | Required | Repeatable | Description |
| --- | --- | --- | --- |
| `<key>` | Yes | No | Redis key targeted by the command. |
| `<ttl>` | Yes | No | Lifetime in milliseconds; `0` restores the key without an expiration. |
| `<serialized-value>` | Yes | No | Payload produced by `DUMP`. |
| `REPLACE` | No | No | Allow replacement of an existing destination. |
| `ABSTTL` | No | No | Treat `<ttl>` as an absolute Unix timestamp in milliseconds. |
| `IDLETIME <seconds>` | No | No | Set the key's idle time, in seconds. |
| `FREQ <frequency>` | No | No | Set the key's access frequency counter. |

## Important points

- This command can expose administrative information or make a broad destructive change. Restrict it to trusted code paths.

## Response

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

| Protocol | Reply |
| --- | --- |
| RESP2 | Simple string `OK` |
| RESP3 | Simple string `OK` |

<Note>
  Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.
</Note>

## Examples

TCP examples use the TLS `REDIS_URL` from the Upstash console. REST examples use `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN`.

<AccordionGroup>

<Accordion title="Redis CLI" icon="terminal">

```bash
RESTORE my-key 1 serialized-value
```

</Accordion>

<Accordion title="@upstash/redis" icon="node-js" iconType="brands">

<Note>
  This command is not supported yet in `@upstash/redis`.
</Note>

</Accordion>

<Accordion title="upstash_redis" icon="python" iconType="brands">

<Note>
  This command is not supported yet in `upstash_redis`.
</Note>

</Accordion>

<Accordion title="ioredis" icon="node-js" iconType="brands">

```ts
import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.restore("my-key", "1", "serialized-value");
console.log(result);
```

</Accordion>

<Accordion title="node-redis" icon="node-js" iconType="brands">

```ts
import { createClient } from "redis";

const client = await createClient({ url: process.env.REDIS_URL })
  .on("error", console.error)
  .connect();
const result = await client.restore("my-key", 1, "serialized-value");
console.log(result);
```

</Accordion>

<Accordion title="redis-py" icon="python" iconType="brands">

```python
import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.restore("my-key", 1, "serialized-value")
print(result)
```

</Accordion>

<Accordion title="go-redis" icon="golang" iconType="brands">

```go
package main

import (
    "context"
    "fmt"
    "os"
    "time"

    "github.com/redis/go-redis/v9"
)

func main() {
    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))
    if err != nil {
        panic(err)
    }
    client := redis.NewClient(opts)
    result, err := client.Restore(context.Background(), "my-key", time.Millisecond, "serialized-value").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println(result)
}
```

</Accordion>

<Accordion title="jedis" icon="java" iconType="brands">

```java
import java.net.URI;

import redis.clients.jedis.Jedis;

try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
  Object result = jedis.restore("my-key", 1, "serialized-value".getBytes());
  System.out.println(result);
}
```

</Accordion>

<Accordion title="redis-rs" icon="rust" iconType="brands">

```rust
fn main() -> redis::RedisResult<()> {
    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");
    let client = redis::Client::open(url)?;
    let mut connection = client.get_connection()?;

    let mut command = redis::cmd("RESTORE");
    command.arg("my-key");
    command.arg("1");
    command.arg("serialized-value");
    let result: redis::Value = command.query(&mut connection)?;
    println!("{result:?}");
    Ok(())
}
```

</Accordion>

</AccordionGroup>