open-vault/website/source/api/system/leases.html.md

layout	page_title	sidebar_title	sidebar_current	description
api	/sys/leases - HTTP API	<tt>/sys/leases</tt>	api-http-system-leases	The `/sys/leases` endpoints are used to view and manage leases.

/sys/leases

The /sys/leases endpoints are used to view and manage leases in Vault.

Read Lease

This endpoint retrieve lease metadata.

Method	Path	Produces
PUT	/sys/leases/lookup	200 application/json

Parameters

• lease_id (string: <required>) – Specifies the ID of the lease to lookup.

Sample Payload

{
  "lease_id": "aws/creds/deploy/abcd-1234..."
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/leases/lookup

Sample Response

{
  "id": "auth/token/create/25c75065466dfc5f920525feafe47502c4c9915c",
  "issue_time": "2017-04-30T10:18:11.228946471-04:00",
  "expire_time": "2017-04-30T11:18:11.228946708-04:00",
  "last_renewal_time": null,
  "renewable": true,
  "ttl": 3558
}

List Leases

This endpoint returns a list of lease ids.

This endpoint requires 'sudo' capability.

Method	Path	Produces
LIST	/sys/leases/lookup/:prefix	200 application/json

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request LIST \
    http://127.0.0.1:8200/v1/sys/leases/lookup/aws/creds/deploy/

Sample Response

{
  "data":{
    "keys":[
      "abcd-1234...",
      "efgh-1234...",
      "ijkl-1234..."
    ]
  }
}

Renew Lease

This endpoint renews a lease, requesting to extend the lease.

Method	Path	Produces
PUT	/sys/leases/renew	200 application/json

Parameters

• lease_id (string: <required>) – Specifies the ID of the lease to extend. This can be specified as part of the URL or as part of the request body.

• increment (int: 0) – Specifies the requested amount of time (in seconds) to extend the lease.

Sample Payload

{
  "lease_id": "aws/creds/deploy/abcd-1234...",
  "increment": 1800
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/leases/renew

Sample Response

{
  "lease_id": "aws/creds/deploy/abcd-1234...",
  "renewable": true,
  "lease_duration": 2764790
}

Revoke Lease

This endpoint revokes a lease immediately.

Method	Path	Produces
PUT	/sys/leases/revoke	204 (empty body)

Parameters

• lease_id (string: <required>) – Specifies the ID of the lease to revoke.

Sample Payload

{
  "lease_id": "postgresql/creds/readonly/abcd-1234..."
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/leases/revoke

Revoke Force

This endpoint revokes all secrets or tokens generated under a given prefix immediately. Unlike /sys/leases/revoke-prefix, this path ignores backend errors encountered during revocation. This is potentially very dangerous and should only be used in specific emergency situations where errors in the backend or the connected backend service prevent normal revocation.

By ignoring these errors, Vault abdicates responsibility for ensuring that the issued credentials or secrets are properly revoked and/or cleaned up. Access to this endpoint should be tightly controlled.

This endpoint requires 'sudo' capability.

Method	Path	Produces
PUT	/sys/leases/revoke-force/:prefix	204 (empty body)

Parameters

• prefix (string: <required>) – Specifies the prefix to revoke. This is specified as part of the URL.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    http://127.0.0.1:8200/v1/sys/leases/revoke-force/aws/creds

Revoke Prefix

This endpoint revokes all secrets (via a lease ID prefix) or tokens (via the tokens' path property) generated under a given prefix immediately. This requires sudo capability and access to it should be tightly controlled as it can be used to revoke very large numbers of secrets/tokens at once.

This endpoint requires 'sudo' capability.

Method	Path	Produces
PUT	/sys/leases/revoke-prefix/:prefix	204 (empty body)

Parameters

• prefix (string: <required>) – Specifies the prefix to revoke. This is specified as part of the URL.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    http://127.0.0.1:8200/v1/sys/leases/revoke-prefix/aws/creds