Apigee Registry API

Service: apigeeregistry.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://apigeeregistry.googleapis.com

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.apis

Methods
create POST /v1/{parent=projects/*/locations/*}/apis
Creates a specified API.
delete DELETE /v1/{name=projects/*/locations/*/apis/*}
Removes a specified API and all of the resources that it owns.
get GET /v1/{name=projects/*/locations/*/apis/*}
Returns a specified API.
getIamPolicy GET /v1/{resource=projects/*/locations/*/apis/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/apis
Returns matching APIs.
patch PATCH /v1/{api.name=projects/*/locations/*/apis/*}
Used to modify a specified API.
setIamPolicy POST /v1/{resource=projects/*/locations/*/apis/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/apis/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.apis.artifacts

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*}/artifacts
Creates a specified artifact.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/artifacts/*}
Removes a specified artifact.
get GET /v1/{name=projects/*/locations/*/apis/*/artifacts/*}
Returns a specified artifact.
getContents GET /v1/{name=projects/*/locations/*/apis/*/artifacts/*}:getContents
Returns the contents of a specified artifact.
getIamPolicy GET /v1/{resource=projects/*/locations/*/apis/*/artifacts/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/apis/*}/artifacts
Returns matching artifacts.
replaceArtifact PUT /v1/{artifact.name=projects/*/locations/*/apis/*/artifacts/*}
Used to replace a specified artifact.
setIamPolicy POST /v1/{resource=projects/*/locations/*/apis/*/artifacts/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/apis/*/artifacts/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.apis.deployments

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*}/deployments
Creates a specified deployment.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/deployments/*}
Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
deleteRevision DELETE /v1/{name=projects/*/locations/*/apis/*/deployments/*}:deleteRevision
Deletes a revision of a deployment.
get GET /v1/{name=projects/*/locations/*/apis/*/deployments/*}
Returns a specified deployment.
getIamPolicy GET /v1/{resource=projects/*/locations/*/apis/*/deployments/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/apis/*}/deployments
Returns matching deployments.
listRevisions GET /v1/{name=projects/*/locations/*/apis/*/deployments/*}:listRevisions
Lists all revisions of a deployment.
patch PATCH /v1/{apiDeployment.name=projects/*/locations/*/apis/*/deployments/*}
Used to modify a specified deployment.
rollback POST /v1/{name=projects/*/locations/*/apis/*/deployments/*}:rollback
Sets the current revision to a specified prior revision.
setIamPolicy POST /v1/{resource=projects/*/locations/*/apis/*/deployments/*}:setIamPolicy
Sets the access control policy on the specified resource.
tagRevision POST /v1/{name=projects/*/locations/*/apis/*/deployments/*}:tagRevision
Adds a tag to a specified revision of a deployment.
testIamPermissions POST /v1/{resource=projects/*/locations/*/apis/*/deployments/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.apis.deployments.artifacts

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*/deployments/*}/artifacts
Creates a specified artifact.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/deployments/*/artifacts/*}
Removes a specified artifact.
get GET /v1/{name=projects/*/locations/*/apis/*/deployments/*/artifacts/*}
Returns a specified artifact.
getContents GET /v1/{name=projects/*/locations/*/apis/*/deployments/*/artifacts/*}:getContents
Returns the contents of a specified artifact.
list GET /v1/{parent=projects/*/locations/*/apis/*/deployments/*}/artifacts
Returns matching artifacts.
replaceArtifact PUT /v1/{artifact.name=projects/*/locations/*/apis/*/deployments/*/artifacts/*}
Used to replace a specified artifact.

REST Resource: v1.projects.locations.apis.versions

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*}/versions
Creates a specified version.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/versions/*}
Removes a specified version and all of the resources that it owns.
get GET /v1/{name=projects/*/locations/*/apis/*/versions/*}
Returns a specified version.
getIamPolicy GET /v1/{resource=projects/*/locations/*/apis/*/versions/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/apis/*}/versions
Returns matching versions.
patch PATCH /v1/{apiVersion.name=projects/*/locations/*/apis/*/versions/*}
Used to modify a specified version.
setIamPolicy POST /v1/{resource=projects/*/locations/*/apis/*/versions/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/apis/*/versions/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.apis.versions.artifacts

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*/versions/*}/artifacts
Creates a specified artifact.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/versions/*/artifacts/*}
Removes a specified artifact.
get GET /v1/{name=projects/*/locations/*/apis/*/versions/*/artifacts/*}
Returns a specified artifact.
getContents GET /v1/{name=projects/*/locations/*/apis/*/versions/*/artifacts/*}:getContents
Returns the contents of a specified artifact.
getIamPolicy GET /v1/{resource=projects/*/locations/*/apis/*/versions/*/artifacts/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/apis/*/versions/*}/artifacts
Returns matching artifacts.
replaceArtifact PUT /v1/{artifact.name=projects/*/locations/*/apis/*/versions/*/artifacts/*}
Used to replace a specified artifact.
setIamPolicy POST /v1/{resource=projects/*/locations/*/apis/*/versions/*/artifacts/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/apis/*/versions/*/artifacts/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.apis.versions.specs

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*/versions/*}/specs
Creates a specified spec.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}
Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
deleteRevision DELETE /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:deleteRevision
Deletes a revision of a spec.
get GET /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}
Returns a specified spec.
getContents GET /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:getContents
Returns the contents of a specified spec.
getIamPolicy GET /v1/{resource=projects/*/locations/*/apis/*/versions/*/specs/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/apis/*/versions/*}/specs
Returns matching specs.
listRevisions GET /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:listRevisions
Lists all revisions of a spec.
patch PATCH /v1/{apiSpec.name=projects/*/locations/*/apis/*/versions/*/specs/*}
Used to modify a specified spec.
rollback POST /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:rollback
Sets the current revision to a specified prior revision.
setIamPolicy POST /v1/{resource=projects/*/locations/*/apis/*/versions/*/specs/*}:setIamPolicy
Sets the access control policy on the specified resource.
tagRevision POST /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:tagRevision
Adds a tag to a specified revision of a spec.
testIamPermissions POST /v1/{resource=projects/*/locations/*/apis/*/versions/*/specs/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.apis.versions.specs.artifacts

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*/versions/*/specs/*}/artifacts
Creates a specified artifact.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}
Removes a specified artifact.
get GET /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}
Returns a specified artifact.
getContents GET /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}:getContents
Returns the contents of a specified artifact.
getIamPolicy GET /v1/{resource=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/apis/*/versions/*/specs/*}/artifacts
Returns matching artifacts.
replaceArtifact PUT /v1/{artifact.name=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}
Used to replace a specified artifact.
setIamPolicy POST /v1/{resource=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.artifacts

Methods
create POST /v1/{parent=projects/*/locations/*}/artifacts
Creates a specified artifact.
delete DELETE /v1/{name=projects/*/locations/*/artifacts/*}
Removes a specified artifact.
get GET /v1/{name=projects/*/locations/*/artifacts/*}
Returns a specified artifact.
getContents GET /v1/{name=projects/*/locations/*/artifacts/*}:getContents
Returns the contents of a specified artifact.
getIamPolicy GET /v1/{resource=projects/*/locations/*/artifacts/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/artifacts
Returns matching artifacts.
replaceArtifact PUT /v1/{artifact.name=projects/*/locations/*/artifacts/*}
Used to replace a specified artifact.
setIamPolicy POST /v1/{resource=projects/*/locations/*/artifacts/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/artifacts/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.instances

Methods
create POST /v1/{parent=projects/*/locations/*}/instances
Provisions instance resources for the Registry.
delete DELETE /v1/{name=projects/*/locations/*/instances/*}
Deletes the Registry instance.
get GET /v1/{name=projects/*/locations/*/instances/*}
Gets details of a single Instance.
getIamPolicy GET /v1/{resource=projects/*/locations/*/instances/*}:getIamPolicy
Gets the access control policy for a resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/instances/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/instances/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.runtime

Methods
getIamPolicy GET /v1/{resource=projects/*/locations/*/runtime}:getIamPolicy
Gets the access control policy for a resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/runtime}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/runtime}:testIamPermissions
Returns permissions that a caller has on the specified resource.