APIHub
Back to Explore

Cloud Private Catalog Producer

The Cloud Private Catalog Producer API enables producers to create, list, update, delete, and copy private catalog resources such as catalogs, products, versions, associations, and product icons, while also offering IAM policy management for those resources. It also provides endpoints for listing and managing long‑running operations.

Uncategorized
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

966ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1beta1/catalogs

Lists Catalog resources that the producer has access to, within the scope of the parent resource.

  • pageSize (query, limit) — The maximum number of catalogs to return.
  • pageToken (query) — A pagination token returned from a previous call to ListCatalogs that indicates where this listing should continue from. This field is optional.
  • parent (query) — The resource name of the parent resource.
POST

/v1beta1/catalogs

Creates a new Catalog resource.

GET

/v1beta1/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

  • filter (query) — The standard list filter.
  • name (query) — The name of the operation's parent resource.
  • pageSize (query, limit) — The standard list page size.
  • pageToken (query) — The standard list page token.
DELETE

/v1beta1/{name}

Hard deletes a Version.

  • name (path, required) — The resource name of the version.
  • force (query) — Forces deletion of the `Catalog` and its `Association` resources. If the `Catalog` is still associated with other resources and force is not set to true, then the operation fails.
GET

/v1beta1/{name}

Returns the requested Version resource.

  • name (path, required) — The resource name of the version.
PATCH

/v1beta1/{name}

Updates a specific Version resource.

  • name (path, required) — Required. The resource name of the version, in the format `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. A unique identifier for the version under a product, which can't be changed after the version is created. The final segment of the name must between 1 and 63 characters in length.
  • updateMask (query) — Field mask that controls which fields of the version should be updated.
POST

/v1beta1/{name}:cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

  • name (path, required) — The name of the operation resource to be cancelled.
POST

/v1beta1/{name}:copy

Copies a Product under another Catalog.

  • name (path, required) — The resource name of the current product that is copied from.
POST

/v1beta1/{name}:undelete

Undeletes a deleted Catalog and all resources under it.

  • name (path, required) — The resource name of the catalog.
GET

/v1beta1/{parent}/associations

Lists all Association resources under a catalog.

  • parent (path, required) — The resource name of the `Catalog` whose `Associations` are being retrieved. In the format `catalogs/ `.
  • pageSize (query, limit) — The maximum number of catalog associations to return.
  • pageToken (query) — A pagination token returned from the previous call to `ListAssociations`.
POST

/v1beta1/{parent}/associations

Creates an Association instance under a given Catalog.

  • parent (path, required) — The `Catalog` resource's name.
GET

/v1beta1/{parent}/products

Lists Product resources that the producer has access to, within the scope of the parent catalog.

  • parent (path, required) — The resource name of the parent resource.
  • filter (query) — A filter expression used to restrict the returned results based upon properties of the product.
  • pageSize (query, limit) — The maximum number of products to return.
  • pageToken (query) — A pagination token returned from a previous call to ListProducts that indicates where this listing should continue from. This field is optional.
POST

/v1beta1/{parent}/products

Creates a Product instance under a given Catalog.

  • parent (path, required) — The catalog name of the new product's parent.
GET

/v1beta1/{parent}/versions

Lists Version resources that the producer has access to, within the scope of the parent Product.

  • parent (path, required) — The resource name of the parent resource.
  • pageSize (query, limit) — The maximum number of versions to return.
  • pageToken (query) — A pagination token returned from a previous call to ListVersions that indicates where this listing should continue from. This field is optional.
POST

/v1beta1/{parent}/versions

Creates a Version instance under a given Product.

  • parent (path, required) — The product name of the new version's parent.
POST

/v1beta1/{product}/icons:upload

Creates an Icon instance under a given Product. If Product only has a default icon, a new Icon instance is created and associated with the given Product. If Product already has a non-default icon, the action creates a new Icon instance, associates the newly created Icon with the given Product and deletes the old icon.

  • product (path, required) — The resource name of the product.
GET

/v1beta1/{resource}:getIamPolicy

Gets IAM policy for the specified Catalog.

  • resource (path, required) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • options.requestedPolicyVersion (query) — Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
POST

/v1beta1/{resource}:setIamPolicy

Sets the IAM policy for the specified Catalog.

  • resource (path, required) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
POST

/v1beta1/{resource}:testIamPermissions

Tests the IAM permissions for the specified Catalog.

  • resource (path, required) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

19 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://cloudprivatecatalogproducer.googleapis.com/v1beta1/catalogs"

cloudprivatecatalogproducer.googleapis.com · HTTPS only