List Retention Policies

GET

/observability/v1/workspaces/{workspace}/engines/{engine}/retention-policies

curl --request GET \
  --url https://example.com/observability/v1/workspaces/example/engines/example/retention-policies

Returns a paginated list of retention policies. A specific provider filters to that provider; - lists across all providers.

Parameters

Path Parameters

workspace

required

string

The workspace whose retention policies to list.

engine

required

string

The provider: qibdo, aws, gcp, or azure, or ’-’ to list across all providers.

Query Parameters

page_size

integer format: int32

The maximum number of policies to return. The service may return fewer than this value. If unspecified, at most 20 items will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token

string

A page token from a previous ListRetentionPolicies call.

filter

string

AIP-160 filter expression.

order_by

string

AIP-132 order_by expression, e.g. ‘created desc’.

Responses

200

OK

Media type application/json

ListRetentionPoliciesResponse

Response for ListRetentionPolicies. Keyset pagination intentionally omits total_size (AIP-158).

object

retention_policies

The list of retention policies.

Array<object>

A retention policy governs how long telemetry is kept for a workspace, per signal pillar (logs, metrics, traces, activity). One policy exists per workspace. The provider that stores the telemetry is reported by the read-only engine field.

object

id

The unique identifier of the retention policy.

stringOutput only

workspace_id

The workspace this policy governs. Derived from the {workspace} path segment on create; reported read-only thereafter.

stringOutput only

location_id

required

Weak reference to a topology Location — where the telemetry resides. Immutable after create.

string

engine

The provider that stores this workspace’s telemetry.

string format: enum Output only

Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE

created

Timestamp when the policy was created.

string format: date-time Output only

updated

Timestamp when the policy was last updated.

string format: date-time Output only

qibdo

Retention windows for a Qibdo-managed workspace.

object

logs_interactive_seconds

required

Interactive log retention window, in seconds (> 0).

string

metrics_interactive_seconds

required

Interactive metric retention window, in seconds (> 0).

string

traces_interactive_seconds

required

Interactive trace retention window, in seconds (> 0).

string

activity_interactive_seconds

required

Interactive activity retention window, in seconds (> 0).

string

next_page_token

A token to retrieve the next page; empty when there are no further pages.

string

Example

{
  "retention_policies": [
    {
      "engine": "ENGINE_UNSPECIFIED"
    }
  ]
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}