diff --git a/daprdocs/content/en/developing-applications/building-blocks/state-management/state-store-ttl.md b/daprdocs/content/en/developing-applications/building-blocks/state-management/state-store-ttl.md index bb150aa38..f40c723ae 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/state-management/state-store-ttl.md +++ b/daprdocs/content/en/developing-applications/building-blocks/state-management/state-store-ttl.md @@ -1,9 +1,9 @@ --- type: docs -title: "How-To: Set state Time-to-Live (TTL)" -linkTitle: "How-To: Set state TTL" +title: "State Time-to-Live (TTL)" +linkTitle: "State TTL" weight: 500 -description: "Manage state with time-to-live." +description: "Manage state with TTL." --- ## Introduction diff --git a/daprdocs/content/en/reference/api/state_api.md b/daprdocs/content/en/reference/api/state_api.md index 011d4d595..bfb8ea05c 100644 --- a/daprdocs/content/en/reference/api/state_api.md +++ b/daprdocs/content/en/reference/api/state_api.md @@ -82,6 +82,16 @@ Field | Description > **ETag format:** Dapr runtime treats ETags as opaque strings. The exact ETag format is defined by the corresponding data store. +#### Metadata + +Metadata can be sent via query parameters in the request's URL. It must be prefixed with `metadata.`, as shown below. + +Parameter | Description +--------- | ----------- +`metadata.ttlInSeconds` | The number of seconds for the message to expire, as [described here]({{< ref state-store-ttl.md >}}) + +> **TTL:** Only certain state stores support the TTL option, according the [supported state stores]({{< ref supported-state-stores.md >}}). + ### HTTP Response #### Response Codes