Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

List Cross-Workspace Pull Grants

GET
/registry/v1/workspaces/{workspace}/engines/{engine}/pull-grants
curl --request GET \
--url https://example.com/registry/v1/workspaces/example/engines/example/pull-grants

Returns a page of the pull grants a source workspace has issued, filtered by AIP-160 expression and ordered per AIP-132.

workspace
required
string
engine
required
string
page_size
integer format: int32

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

page_token
string
filter
string

AIP-160 filter expression. Filterable fields: create_time, engine, id, repo_name_pattern, repository_id, source_workspace_id, target_workspace_id, update_time.

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).

OK

Media type application/json

ListCrossWorkspacePullGrantsResponse

Response message for ListCrossWorkspacePullGrants.

object
cross_workspace_pull_grants
Array<object>

A cross-workspace pull grant lets principals of a TARGET workspace pull (read-only) from a SOURCE workspace’s registry — either one specific source repository or a glob of source repository names. Sharing out a source workspace’s repositories is the source owner’s act, so a grant is created under the source workspace path. Grants are pull-only by construction: there is no action field and no push is ever conferred.

object
id
stringOutput only
engine

The provider the grant applies to.

string format: enum Output only
Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO
source_workspace_id

The workspace whose repositories are shared. Stamped from the request path — a caller cannot address one workspace in the path and grant out another’s repositories.

stringOutput only
target_workspace_id
required

The workspace whose principals gain pull access to the source’s repositories.

string
repository_id

A specific source repository to share. Exactly one of repository_id or repo_name_pattern must be set (enforced by the domain model). Present when the grant targets a single repository.

string
repo_name_pattern

A glob over source repository names (doublestar syntax, e.g. web/**). Exactly one of repository_id or repo_name_pattern must be set. Present when the grant targets a pattern.

string
create_time

Created Timestamp

When this grant was created.

string format: date-time Output only
update_time

Updated Timestamp

When this grant was last updated.

string format: date-time Output only
next_page_token
string
total_size

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

string
Example
{
"cross_workspace_pull_grants": [
{
"engine": "ENGINE_UNSPECIFIED"
}
]
}

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