# JSON.DEL

> Delete JSON values.

Use `JSON.DEL` to delete the value at a path in a JSON document.

Without a path the entire key is deleted. The reply is the number of values that were deleted, which is `0` when the path matched nothing, and deleting the root of a document removes the key itself. With a JSONPath that matches several places, every match is removed in the same call.

[`JSON.FORGET`](/redis/commands/json/json-forget) is an alias with identical behavior.

## Syntax

```redis
JSON.DEL <key> [path]
```

## Arguments

| Argument | Required | Repeatable | Description |
| --- | --- | --- | --- |
| `key` | Yes | No | JSON document key. |
| `path` | No | No | Path to delete; omitting it deletes the whole key. |

## Important points

- Raw TCP examples pass JSON values as valid JSON text. Typed Upstash SDK helpers serialize native objects and values for you.
- Paths beginning with `$` use JSONPath and can match multiple values, so many JSON commands return an array of per-match results.

## 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 | Integer |
| RESP3 | Integer |

<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
JSON.DEL profile $.temporary
```

</Accordion>

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

```ts
import { Redis } from "@upstash/redis";

const redis = Redis.fromEnv();

await redis.json.del("key", "$.path.to.value");
```

</Accordion>

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

```python
from upstash_redis import Redis

redis = Redis.from_env()
result = redis.json().delete("profile", "$.temporary")
print(result)
```

</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.call("JSON.DEL", "profile", "$.temporary");
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.json.del("profile", { path: "$.temporary" });
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.json().delete("profile", "$.temporary")
print(result)
```

</Accordion>

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

```go
package main

import (
    "context"
    "fmt"
    "os"

    "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.JSONDel(context.Background(), "profile", "$.temporary").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.JedisPooled;

try (JedisPooled jedis = new JedisPooled(new URI(System.getenv("REDIS_URL")))) {
  Object result = jedis.jsonDel("profile", new redis.clients.jedis.json.Path("$.temporary"));
  System.out.println(result);
}
```

</Accordion>

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

```rust
use redis::JsonCommands;

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 result: redis::Value = connection.json_del("profile", "$.temporary")?;
    println!("{result:?}");
    Ok(())
}
```

</Accordion>

</AccordionGroup>