List Retention Policies

GET

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

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

Returns a page of retention policies for the workspace registry, filtered by AIP-160 expression and ordered per AIP-132.

Parameters

Path Parameters

workspace

required

string

engine

required

string

Query Parameters

page_size

integer format: int32

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

page_token

string

A page token, received from a previous ListRetentionPolicies call.

filter

string

AIP-160 filter expression. Filterable fields: create_time, enabled, engine, id, schedule, update_time, workspace_id.

order_by

string

AIP-132 order_by expression. Sortable fields: create_time, engine, update_time.

skip

string

AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).

Responses

200

OK

Media type application/json

ListRetentionPoliciesResponse

Response message for ListRetentionPolicies.

object

retention_policies

The list of retention policies.

Array<object>

A retention policy controls automatic garbage-collection of artifacts in a workspace registry — e.g. “keep the last 10 tags matching v*, plus anything tagged in the last 30 days”. Retention runs project-wide on the backend, so a retention policy is scoped to the whole workspace.

object

id

stringOutput only

workspace_id

The workspace this retention policy applies to.

stringOutput only

engine

The provider this retention policy applies to.

string format: enum Output only

Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO

rules

required

The retention rules evaluated on each run.

Array<object>

object

keep_last_n

integer format: int32

keep_newer_than

Keep artifacts newer than this age.

string

/^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$/

keep_tag_pattern

string

schedule

A cron-style schedule string controlling when retention runs.

string

enabled

Whether the policy is active.

boolean

create_time

string format: date-time Output only

update_time

string format: date-time Output only

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

string

total_size

Exact count of resources matching the request’s filter and scope (both pagination modes).

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"
    }
  ]
}