Skip to main content
GET
List pull-through cache rules
Requires the IAM action registry:DescribePullThroughCacheRules. See REGISTRY permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Query Parameters

name
string

Exact, account-scoped immutable repository name or cache-rule prefix. Slash-bearing names are accepted. Intersects with crn before pagination.

Example:

"team/app"

crn
string

Exact pull-through-cache-rule CRN, intersected with name. Malformed CRN syntax returns 400 INVALID_INPUT. A valid CRN for a different service, type, region or account returns an empty list. Slash-bearing prefixes remain part of the opaque rule name.

Example:

"crn:registry:sa-saopaulo-1:my-account:pull-through-cache-rule/hub/library"

Response

Every matching rule in the account. Unpaged — the count is bounded by a quota in the low tens.

pull_through_cache_rules
object[]
required