2026-08-20
▼ ▲ apigeeregistry.projects.locations.operations.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Required : Yes
Description : The name of the operation resource.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type : string
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ apigeeregistry.projects.locations.operations.cancel
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Parameter Order : name
Path : v1/{+name}:cancel
Description : 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`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
▼ ▲ apigeeregistry.projects.locations.operations.list
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters :
name
Required : Yes
Description : The name of the operation's parent resource.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
filter
Location : query
Type : string
Description : The standard list filter.
pageSize
Description : The standard list page size.
Location : query
Format : int32
Type : integer
pageToken
Location : query
Type : string
Description : The standard list page token.
Path : v1/{+name}/operations
Parameter Order : name
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
▼ ▲ apigeeregistry.projects.locations.operations.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameters :
name
Required : Yes
Description : The name of the operation resource to be deleted.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type : string
Path : v1/{+name}
Parameter Order : name
▼ ▲ apigeeregistry.projects.locations.apis.getIamPolicy
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
Parameters :
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Format : int32
Type : integer
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ apigeeregistry.projects.locations.apis.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis
HTTP Method : GET
Parameters :
pageSize
Description : The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Location : query
Format : int32
Type : integer
filter
Location : query
Type : string
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Description : Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`
orderBy
Description : A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
Location : query
Type : string
pageToken
Description : A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApis` must match the call that provided the page token.
Location : query
Type : string
Path : v1/{+parent}/apis
Parameter Order : parent
Description : Returns matching APIs.
▼ ▲ apigeeregistry.projects.locations.apis.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : parent
Path : v1/{+parent}/apis
Parameters :
parent
Description : Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
apiId
Type : string
Location : query
Description : Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Description : Creates a specified API.
▼ ▲ apigeeregistry.projects.locations.apis.patch
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}
Description : Used to modify a specified API.
Parameters :
updateMask
Description : The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
Type : string
Location : query
Format : google-fieldmask
name
Required : Yes
Description : Resource name.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
allowMissing
Description : If set to true, and the API is not found, a new API will be created. In this situation, `update_mask` is ignored.
Type : boolean
Location : query
Path : v1/{+name}
Parameter Order : name
▼ ▲ apigeeregistry.projects.locations.apis.setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+resource}:setIamPolicy
Parameter Order : resource
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
Location : path
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ apigeeregistry.projects.locations.apis.get
Description : Returns a specified API.
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The name of the API to retrieve. Format: `projects/*/locations/*/apis/*`
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}
▼ ▲ apigeeregistry.projects.locations.apis.testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
Required : Yes
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ apigeeregistry.projects.locations.apis.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Path : v1/{+name}
Parameter Order : name
Parameters :
force
Description : If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Type : boolean
Location : query
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
Description : Required. The name of the API to delete. Format: `projects/*/locations/*/apis/*`
Required : Yes
Description : Removes a specified API and all of the resources that it owns.
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.get
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns a specified artifact.
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Type : string
Description : Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`
Required : Yes
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.delete
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Removes a specified artifact.
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Type : string
Description : Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`
Required : Yes
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.testIamPermissions
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Path : v1/{+resource}:testIamPermissions
Parameter Order : resource
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.list
Description : Returns matching artifacts.
Parameters :
orderBy
Description : A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
Type : string
Location : query
pageToken
Description : A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
Location : query
Type : string
parent
Required : Yes
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
filter
Type : string
Location : query
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Path : v1/{+parent}/artifacts
Parameter Order : parent
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+parent}/artifacts
Parameter Order : parent
Parameters :
parent
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
artifactId
Type : string
Location : query
Description : Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Description : Creates a specified artifact.
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.replaceArtifact
HTTP Method : PUT
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}
Description : Used to replace a specified artifact.
Parameters :
name
Required : Yes
Description : Resource name.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Type : string
Path : v1/{+name}
Parameter Order : name
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+resource}:setIamPolicy
Parameter Order : resource
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.getContents
Parameter Order : name
Path : v1/{+name}:getContents
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Type : string
Description : Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`
Required : Yes
Description : Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getContents
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.getIamPolicy
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Type : string
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type : integer
Location : query
Format : int32
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.get
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns a specified spec.
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the spec to retrieve. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.deleteRevision
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:deleteRevision
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a revision of a spec.
Parameter Order : name
Path : v1/{+name}:deleteRevision
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8`
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.rollback
Parameters :
name
Description : Required. The spec being rolled back.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Parameter Order : name
Path : v1/{+name}:rollback
Description : Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:rollback
HTTP Method : POST
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.create
Description : Creates a specified spec.
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
Required : Yes
Description : Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`
apiSpecId
Location : query
Type : string
Description : Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Path : v1/{+parent}/specs
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.setIamPolicy
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path : v1/{+resource}:setIamPolicy
Parameter Order : resource
Parameters :
resource
Required : Yes
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.tagRevision
Description : Adds a tag to a specified revision of a spec.
Path : v1/{+name}:tagRevision
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the spec to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:tagRevision
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.patch
Description : Used to modify a specified spec.
Parameters :
updateMask
Description : The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
Location : query
Format : google-fieldmask
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Location : path
Description : Resource name.
Required : Yes
allowMissing
Description : If set to true, and the spec is not found, a new spec will be created. In this situation, `update_mask` is ignored.
Type : boolean
Location : query
Parameter Order : name
Path : v1/{+name}
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.delete
Description : Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
Parameters :
force
Description : If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Location : query
Type : boolean
name
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Location : path
Description : Required. The name of the spec to delete. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
Required : Yes
Parameter Order : name
Path : v1/{+name}
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.testIamPermissions
Parameters :
resource
Required : Yes
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Location : path
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:testIamPermissions
HTTP Method : POST
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.listRevisions
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:listRevisions
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
Parameter Order : name
Path : v1/{+name}:listRevisions
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Location : path
Description : Required. The name of the spec to list revisions for.
Required : Yes
pageSize
Description : The maximum number of revisions to return per page.
Type : integer
Location : query
Format : int32
pageToken
Description : The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page.
Type : string
Location : query
filter
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Type : string
Location : query
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.list
Description : Returns matching specs.
Parameters :
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
filter
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Type : string
Location : query
pageToken
Description : A page token, received from a previous `ListApiSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiSpecs` must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
Type : string
Location : query
parent
Required : Yes
Description : Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
Location : path
Path : v1/{+parent}/specs
Parameter Order : parent
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.getContents
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the spec whose contents should be retrieved. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
Parameter Order : name
Path : v1/{+name}:getContents
Description : Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getContents
HTTP Method : GET
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getIamPolicy
HTTP Method : GET
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Format : int32
Type : integer
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.list
Parameter Order : parent
Path : v1/{+parent}/artifacts
Parameters :
parent
Required : Yes
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
pageToken
Description : A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
Location : query
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
filter
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Location : query
Type : string
Description : Returns matching artifacts.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.create
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type : string
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Required : Yes
artifactId
Description : Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Location : query
Type : string
Path : v1/{+parent}/artifacts
Parameter Order : parent
Description : Creates a specified artifact.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts
HTTP Method : POST
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.replaceArtifact
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Required : Yes
Description : Resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Description : Used to replace a specified artifact.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PUT
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Type : string
Path : v1/{+resource}:setIamPolicy
Parameter Order : resource
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.delete
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`
Description : Removes a specified artifact.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Path : v1/{+resource}:testIamPermissions
Parameter Order : resource
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:testIamPermissions
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}
Description : Returns a specified artifact.
Parameters :
name
Description : Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Type : string
Parameter Order : name
Path : v1/{+name}
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.getIamPolicy
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Type : string
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Format : int32
Type : integer
Parameter Order : resource
Path : v1/{+resource}:getIamPolicy
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getIamPolicy
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.getContents
Description : Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
Parameter Order : name
Path : v1/{+name}:getContents
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getContents
▼ ▲ apigeeregistry.projects.locations.apis.versions.get
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Required : Yes
Description : Required. The name of the version to retrieve. Format: `projects/*/locations/*/apis/*/versions/*`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
Description : Returns a specified version.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ apigeeregistry.projects.locations.apis.versions.testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
Required : Yes
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ apigeeregistry.projects.locations.apis.versions.delete
Description : Removes a specified version and all of the resources that it owns.
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Description : Required. The name of the version to delete. Format: `projects/*/locations/*/apis/*/versions/*`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
Location : path
force
Description : If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Location : query
Type : boolean
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}
▼ ▲ apigeeregistry.projects.locations.apis.versions.getIamPolicy
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
Parameters :
options.requestedPolicyVersion
Type : integer
Location : query
Format : int32
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
Location : path
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:getIamPolicy
▼ ▲ apigeeregistry.projects.locations.apis.versions.list
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions
Description : Returns matching versions.
Parameters :
orderBy
Location : query
Type : string
Description : A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageToken
Description : A page token, received from a previous `ListApiVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiVersions` must match the call that provided the page token.
Location : query
Type : string
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
Required : Yes
Description : Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
filter
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Type : string
Location : query
Path : v1/{+parent}/versions
Parameter Order : parent
▼ ▲ apigeeregistry.projects.locations.apis.versions.create
Description : Creates a specified version.
Path : v1/{+parent}/versions
Parameter Order : parent
Parameters :
parent
Required : Yes
Description : Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
Location : path
apiVersionId
Location : query
Type : string
Description : Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions
▼ ▲ apigeeregistry.projects.locations.apis.versions.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Required : Yes
Description : Resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
Location : path
allowMissing
Location : query
Type : boolean
Description : If set to true, and the version is not found, a new version will be created. In this situation, `update_mask` is ignored.
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
Description : Used to modify a specified version.
▼ ▲ apigeeregistry.projects.locations.apis.versions.setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+resource}:setIamPolicy
Parameter Order : resource
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type : string
Location : path
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.delete
Description : Removes a specified artifact.
Parameters :
name
Description : Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Parameter Order : name
Path : v1/{+name}
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}
HTTP Method : GET
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Description : Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`
Required : Yes
Path : v1/{+name}
Parameter Order : name
Description : Returns a specified artifact.
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.getContents
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}:getContents
HTTP Method : GET
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$
Type : string
Description : Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`
Required : Yes
Path : v1/{+name}:getContents
Parameter Order : name
Description : Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.list
Description : Returns matching artifacts.
Parameter Order : parent
Path : v1/{+parent}/artifacts
Parameters :
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
filter
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Location : query
Type : string
pageToken
Type : string
Location : query
Description : A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
orderBy
Description : A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
Location : query
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Location : path
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Required : Yes
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.create
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a specified artifact.
Parameter Order : parent
Path : v1/{+parent}/artifacts
Parameters :
parent
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
artifactId
Description : Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Location : query
Type : string
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.replaceArtifact
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Description : Resource name.
Required : Yes
Description : Used to replace a specified artifact.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PUT
▼ ▲ apigeeregistry.projects.locations.apis.deployments.delete
Parameters :
name
Description : Required. The name of the deployment to delete. Format: `projects/*/locations/*/apis/*/deployments/*`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Location : path
force
Description : If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Type : boolean
Location : query
Parameter Order : name
Path : v1/{+name}
Description : Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}
HTTP Method : DELETE
▼ ▲ apigeeregistry.projects.locations.apis.deployments.rollback
Description : Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Location : path
Description : Required. The deployment being rolled back.
Required : Yes
Parameter Order : name
Path : v1/{+name}:rollback
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:rollback
▼ ▲ apigeeregistry.projects.locations.apis.deployments.testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:testIamPermissions
▼ ▲ apigeeregistry.projects.locations.apis.deployments.get
Description : Returns a specified deployment.
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Description : Required. The name of the deployment to retrieve. Format: `projects/*/locations/*/apis/*/deployments/*`
Required : Yes
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}
▼ ▲ apigeeregistry.projects.locations.apis.deployments.deleteRevision
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:deleteRevision
Description : Deletes a revision of a deployment.
Parameters :
name
Required : Yes
Description : Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Path : v1/{+name}:deleteRevision
Parameter Order : name
▼ ▲ apigeeregistry.projects.locations.apis.deployments.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments
HTTP Method : GET
Parameters :
pageSize
Description : The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Location : query
Format : int32
Type : integer
filter
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Type : string
Location : query
orderBy
Description : A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
Location : query
Type : string
pageToken
Description : A page token, received from a previous `ListApiDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiDeployments` must match the call that provided the page token.
Type : string
Location : query
parent
Description : Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
Location : path
Parameter Order : parent
Path : v1/{+parent}/deployments
Description : Returns matching deployments.
▼ ▲ apigeeregistry.projects.locations.apis.deployments.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments
HTTP Method : POST
Parameters :
parent
Required : Yes
Description : Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
apiDeploymentId
Location : query
Type : string
Description : Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Path : v1/{+parent}/deployments
Parameter Order : parent
Description : Creates a specified deployment.
▼ ▲ apigeeregistry.projects.locations.apis.deployments.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:setIamPolicy
▼ ▲ apigeeregistry.projects.locations.apis.deployments.listRevisions
Parameter Order : name
Path : v1/{+name}:listRevisions
Parameters :
name
Description : Required. The name of the deployment to list revisions for.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Location : path
pageSize
Description : The maximum number of revisions to return per page.
Location : query
Format : int32
Type : integer
pageToken
Description : The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page.
Location : query
Type : string
filter
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Location : query
Type : string
Description : Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:listRevisions
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ apigeeregistry.projects.locations.apis.deployments.tagRevision
Description : Adds a tag to a specified revision of a deployment.
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The name of the deployment to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision.
Parameter Order : name
Path : v1/{+name}:tagRevision
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:tagRevision
▼ ▲ apigeeregistry.projects.locations.apis.deployments.patch
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Used to modify a specified deployment.
Path : v1/{+name}
Parameter Order : name
Parameters :
updateMask
Description : The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
Location : query
Format : google-fieldmask
Type : string
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Description : Resource name.
Required : Yes
allowMissing
Description : If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored.
Type : boolean
Location : query
▼ ▲ apigeeregistry.projects.locations.apis.deployments.getIamPolicy
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:getIamPolicy
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters :
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type : integer
Location : query
Format : int32
resource
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type : string
Location : path
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.getIamPolicy
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
Parameters :
options.requestedPolicyVersion
Type : integer
Location : query
Format : int32
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Type : string
Location : path
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.getContents
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getContents
Description : Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`
Path : v1/{+name}:getContents
Parameter Order : name
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts
HTTP Method : GET
Parameters :
orderBy
Type : string
Location : query
Description : A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageToken
Type : string
Location : query
Description : A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
parent
Required : Yes
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
pageSize
Type : integer
Location : query
Format : int32
Description : The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
filter
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Type : string
Location : query
Parameter Order : parent
Path : v1/{+parent}/artifacts
Description : Returns matching artifacts.
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.create
Description : Creates a specified artifact.
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type : string
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Required : Yes
artifactId
Description : Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Type : string
Location : query
Path : v1/{+parent}/artifacts
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.replaceArtifact
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PUT
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Description : Resource name.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Description : Used to replace a specified artifact.
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Path : v1/{+resource}:setIamPolicy
Parameter Order : resource
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:setIamPolicy
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.get
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns a specified artifact.
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}
Description : Removes a specified artifact.
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`
Parameter Order : name
Path : v1/{+name}
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.testIamPermissions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+resource}:testIamPermissions
Parameter Order : resource
Parameters :
resource
Required : Yes
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ apigeeregistry.projects.locations.instances.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
Description : Deletes the Registry instance.
Parameters :
name
Description : Required. The name of the Instance to delete. Format: `projects/*/locations/*/instances/*`.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Type : string
Parameter Order : name
Path : v1/{+name}
▼ ▲ apigeeregistry.projects.locations.instances.testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters :
resource
Required : Yes
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Type : string
Location : path
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions
▼ ▲ apigeeregistry.projects.locations.instances.get
Description : Gets details of a single Instance.
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Type : string
Description : Required. The name of the Instance to retrieve. Format: `projects/*/locations/*/instances/*`.
Required : Yes
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
▼ ▲ apigeeregistry.projects.locations.instances.create
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Provisions instance resources for the Registry.
Parameter Order : parent
Path : v1/{+parent}/instances
Parameters :
parent
Required : Yes
Description : Required. Parent resource of the Instance, of the form: `projects/*/locations/*`
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
instanceId
Type : string
Location : query
Description : Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
▼ ▲ apigeeregistry.projects.locations.instances.setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Type : string
Location : path
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Path : v1/{+resource}:setIamPolicy
Parameter Order : resource
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ apigeeregistry.projects.locations.instances.getIamPolicy
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters :
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type : integer
Location : query
Format : int32
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Type : string
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
▼ ▲ apigeeregistry.projects.locations.documents.getIamPolicy
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/documents:getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameter Order : resource
Path : v1/{+resource}:getIamPolicy
Parameters :
options.requestedPolicyVersion
Location : query
Format : int32
Type : integer
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/documents$
Type : string
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
▼ ▲ apigeeregistry.projects.locations.documents.testIamPermissions
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/documents:testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/documents$
Type : string
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
▼ ▲ apigeeregistry.projects.locations.documents.setIamPolicy
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/documents:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/documents$
Type : string
Location : path
Required : Yes
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
▼ ▲ apigeeregistry.projects.locations.runtime.getIamPolicy
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters :
options.requestedPolicyVersion
Location : query
Format : int32
Type : integer
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Pattern : ^projects/[^/]+/locations/[^/]+/runtime$
Type : string
Location : path
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Parameter Order : resource
Path : v1/{+resource}:getIamPolicy
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/runtime:getIamPolicy
▼ ▲ apigeeregistry.projects.locations.runtime.testIamPermissions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/runtime:testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/runtime$
Type : string
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ apigeeregistry.projects.locations.runtime.setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/runtime:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+resource}:setIamPolicy
Parameter Order : resource
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/runtime$
Type : string
Location : path
Required : Yes
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ apigeeregistry.projects.locations.artifacts.delete
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`
Description : Removes a specified artifact.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ apigeeregistry.projects.locations.artifacts.testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Required : Yes
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ apigeeregistry.projects.locations.artifacts.get
Parameters :
name
Description : Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Path : v1/{+name}
Parameter Order : name
Description : Returns a specified artifact.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}
HTTP Method : GET
▼ ▲ apigeeregistry.projects.locations.artifacts.list
Parameter Order : parent
Path : v1/{+parent}/artifacts
Parameters :
pageSize
Type : integer
Location : query
Format : int32
Description : The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
filter
Type : string
Location : query
Description : An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
pageToken
Location : query
Type : string
Description : A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
orderBy
Description : A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
Location : query
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Description : Returns matching artifacts.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/artifacts
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ apigeeregistry.projects.locations.artifacts.create
Description : Creates a specified artifact.
Parameters :
artifactId
Location : query
Type : string
Description : Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Description : Required. The parent, which owns this collection of artifacts. Format: `{parent}`
Path : v1/{+parent}/artifacts
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/artifacts
▼ ▲ apigeeregistry.projects.locations.artifacts.replaceArtifact
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Description : Resource name.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Type : string
Description : Used to replace a specified artifact.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PUT
▼ ▲ apigeeregistry.projects.locations.artifacts.setIamPolicy
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Type : string
Location : path
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:setIamPolicy
HTTP Method : POST
▼ ▲ apigeeregistry.projects.locations.artifacts.getContents
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getContents
Description : Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
Parameters :
name
Required : Yes
Description : Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Type : string
Path : v1/{+name}:getContents
Parameter Order : name
▼ ▲ apigeeregistry.projects.locations.artifacts.getIamPolicy
Parameter Order : resource
Path : v1/{+resource}:getIamPolicy
Parameters :
resource
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Type : string
Location : path
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type : integer
Location : query
Format : int32
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ apigeeregistry.projects.locations.list
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations
Description : Lists information about the supported locations for this service.
Parameters :
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Type : string
Location : query
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Format : int32
Type : integer
pageToken
Location : query
Type : string
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
name
Description : The resource that owns the locations collection, if applicable.
Required : Yes
Pattern : ^projects/[^/]+$
Type : string
Location : path
Path : v1/{+name}/locations
Parameter Order : name
▼ ▲ apigeeregistry.projects.locations.get
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Required : Yes
Description : Resource name for the location.