# Revoke a secret

DELETE

/v1/secrets/{name}

```sh
curl --request DELETE \
  --url 'https://example.com/v1/secrets/example?envName=example&scopeKind=tenant' \
  --header 'Authorization: Bearer <token>'
```

Requires the `secrets:revoke` capability (soft-revoke), or `secrets:revoke:hard` when `?hard=true`: that erases the value at Kindgi and hard-deletes it in a secret manager, and can’t be undone. Backups, and a secret manager’s own retention, may keep copies for a time. If your secret manager keeps a recoverable copy, the answer’s `recoverableUntil` says until when. Optional `?reason=<text>` records the revoke reason.

## Authorizations

- **[bearerAuth](https://docs.kindgi.com/v0.3.1/reference/api.md#bearerauth)**

## Parameters

### Path Parameters

**name**

required

string

\>= 1 characters

Secret name (opaque string within the tenant + envName).

### Query Parameters

**envName**

required

Per-environment slug. `[a-z][a-z0-9-]{0,62}` — RFC-1035-like label.

string

/^\[a-z]\[a-z0-9-]{0,62}$/

`[a-z][a-z0-9-]{0,62}`. Required on every env + secrets route.

**scopeKind**

required

Discriminator for the ?scopeKind + ?scopeId + ?inherit triplet. Tenant carries no id (implicit from session); org/project require scopeId.

string

Allowed values: tenant org project

Required on every env + secrets route. Tenant carries no `scopeId`; org / project require `scopeId`.

**scopeId**

string

\>= 1 characters

Required IF scopeKind is `org` or `project`. MUST be absent if scopeKind=`tenant` (tenant is implicit from the session). Malformed combinations return 400 scope-invalid.

**hard**

boolean

Set to `true` to erase the value, which can’t be undone. Backups, and a secret manager’s own retention, may keep copies for a time. If your secret manager keeps a recoverable copy, the answer’s `recoverableUntil` says until when.

**reason**

string

Human-readable revoke reason retained in the tombstone.

## Responses

### 200

Revoke outcome.

application/json

object

**revoked**

required

boolean

**hard**

required

boolean

**recoverableUntil**

A hard revoke left a copy your secret manager can still recover (for example Azure Key Vault’s soft delete, when the vault doesn’t allow a purge or the runtime isn’t permitted to purge): when the secret manager purges it on its own. Setting the same name again before then can keep that copy, its values disabled, until the name is hard-revoked again. Absent on a soft revoke, and when a hard revoke left nothing recoverable.

string format: date-time

##### Examplegenerated

```json
{
  "revoked": true,
  "hard": true,
  "recoverableUntil": "2026-04-15T12:00:00Z"
}
```

### 400

Missing or malformed scope / envName, or `reserved-name-prefix` for a `kindgi.` name.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 401

Missing / malformed / expired / revoked bearer token.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 403

Bearer token missing revoke capability.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 404

Unknown secret.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 501

The store doesn’t revoke (`secret-operation-unsupported`): under `kindgi dev` secrets live in the env files; the message says to remove the name there.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

## See also

- [`GET /v1/secrets/{name}`: Get secret metadata](https://docs.kindgi.com/v0.3.1/reference/api/operations/secretsget.md)
- [`GET /v1/secrets/{name}/versions`: List secret versions](https://docs.kindgi.com/v0.3.1/reference/api/operations/secretslistversions.md)
- [`GET /v1/secrets/{name}/versions/{versionId}`: Get one secret-version record](https://docs.kindgi.com/v0.3.1/reference/api/operations/secretsgetversion.md)
- [`POST /v1/secrets/{name}/rotate`: Rotate a secret (sync or async)](https://docs.kindgi.com/v0.3.1/reference/api/operations/secretsrotate.md)
- [Keep secrets in your own secret manager](https://docs.kindgi.com/v0.3.1/deploy/self-hosted/secret-manager.md)
- [Kindgi 0.2.0](https://docs.kindgi.com/v0.3.1/releases/0.2.0.md)
- [Error code `reserved-name-prefix`](https://docs.kindgi.com/v0.3.1/reference/errors.md#reserved-name-prefix)
- [Error code `secret-operation-unsupported`](https://docs.kindgi.com/v0.3.1/reference/errors.md#secret-operation-unsupported)
- [Every error code](https://docs.kindgi.com/v0.3.1/reference/errors.md)