Apigee

Registry API

The Registry service allows teams to manage descriptions of APIs.

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Registry service allows teams to manage descriptions of APIs.

Endpoints 35

Registry

  • GETRegistry_ListApis/v1/projects/:project/locations/:location/apis?pageSize=0&pageToken=string&filter=stringListApis returns matching APIs.
  • POSTRegistry_CreateApi/v1/projects/:project/locations/:location/apis?apiId=stringCreateApi creates a specified API.
  • GETRegistry_GetApi/v1/projects/:project/locations/:location/apis/:apiGetApi returns a specified API.
  • DELETERegistry_DeleteApi/v1/projects/:project/locations/:location/apis/:api?force=trueDeleteApi removes a specified API and all of the resources that it owns.
  • PATCHRegistry_UpdateApi/v1/projects/:project/locations/:location/apis/:api?updateMask=string&allowMissing=trueUpdateApi can be used to modify a specified API.
  • GETRegistry_ListApiDeployments/v1/projects/:project/locations/:location/apis/:api/deployments?pageSize=0&pageToken=string&filter=stringListApiDeployments returns matching deployments.
  • POSTRegistry_CreateApiDeployment/v1/projects/:project/locations/:location/apis/:api/deployments?apiDeploymentId=stringCreateApiDeployment creates a specified deployment.
  • GETRegistry_GetApiDeployment/v1/projects/:project/locations/:location/apis/:api/deployments/:deploymentGetApiDeployment returns a specified deployment.
  • DELETERegistry_DeleteApiDeployment/v1/projects/:project/locations/:location/apis/:api/deployments/:deployment?force=trueDeleteApiDeployment removes a specified deployment, all revisions, and all child resources (e.g. artifacts).
  • PATCHRegistry_UpdateApiDeployment/v1/projects/:project/locations/:location/apis/:api/deployments/:deployment?updateMask=string&allowMissing=trueUpdateApiDeployment can be used to modify a specified deployment.
  • DELETERegistry_DeleteApiDeploymentRevision/v1/projects/:project/locations/:location/apis/:api/deployments/:deployment:deleteRevisionDeleteApiDeploymentRevision deletes a revision of a deployment.
  • GETRegistry_ListApiDeploymentRevisions/v1/projects/:project/locations/:location/apis/:api/deployments/:deployment:listRevisions?pageSize=0&pageToken=stringListApiDeploymentRevisions lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
  • POSTRegistry_RollbackApiDeployment/v1/projects/:project/locations/:location/apis/:api/deployments/:deployment:rollbackRollbackApiDeployment sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
  • POSTRegistry_TagApiDeploymentRevision/v1/projects/:project/locations/:location/apis/:api/deployments/:deployment:tagRevisionTagApiDeploymentRevision adds a tag to a specified revision of a deployment.
  • GETRegistry_ListApiVersions/v1/projects/:project/locations/:location/apis/:api/versions?pageSize=0&pageToken=string&filter=stringListApiVersions returns matching versions.
  • POSTRegistry_CreateApiVersion/v1/projects/:project/locations/:location/apis/:api/versions?apiVersionId=stringCreateApiVersion creates a specified version.
  • GETRegistry_GetApiVersion/v1/projects/:project/locations/:location/apis/:api/versions/:versionGetApiVersion returns a specified version.
  • DELETERegistry_DeleteApiVersion/v1/projects/:project/locations/:location/apis/:api/versions/:version?force=trueDeleteApiVersion removes a specified version and all of the resources that it owns.
  • PATCHRegistry_UpdateApiVersion/v1/projects/:project/locations/:location/apis/:api/versions/:version?updateMask=string&allowMissing=trueUpdateApiVersion can be used to modify a specified version.
  • GETRegistry_ListApiSpecs/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs?pageSize=0&pageToken=string&filter=stringListApiSpecs returns matching specs.
  • POSTRegistry_CreateApiSpec/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs?apiSpecId=stringCreateApiSpec creates a specified spec.
  • GETRegistry_GetApiSpec/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs/:specGetApiSpec returns a specified spec.
  • DELETERegistry_DeleteApiSpec/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs/:spec?force=trueDeleteApiSpec removes a specified spec, all revisions, and all child resources (e.g. artifacts).
  • PATCHRegistry_UpdateApiSpec/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs/:spec?updateMask=string&allowMissing=trueUpdateApiSpec can be used to modify a specified spec.
  • DELETERegistry_DeleteApiSpecRevision/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs/:spec:deleteRevisionDeleteApiSpecRevision deletes a revision of a spec.
  • GETRegistry_GetApiSpecContents/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs/:spec:getContentsGetApiSpecContents returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec…
  • GETRegistry_ListApiSpecRevisions/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs/:spec:listRevisions?pageSize=0&pageToken=stringListApiSpecRevisions lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
  • POSTRegistry_RollbackApiSpec/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs/:spec:rollbackRollbackApiSpec sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
  • POSTRegistry_TagApiSpecRevision/v1/projects/:project/locations/:location/apis/:api/versions/:version/specs/:spec:tagRevisionTagApiSpecRevision adds a tag to a specified revision of a spec.
  • GETRegistry_ListArtifacts/v1/projects/:project/locations/:location/artifacts?pageSize=0&pageToken=string&filter=stringListArtifacts returns matching artifacts.
  • POSTRegistry_CreateArtifact/v1/projects/:project/locations/:location/artifacts?artifactId=stringCreateArtifact creates a specified artifact.
  • GETRegistry_GetArtifact/v1/projects/:project/locations/:location/artifacts/:artifactGetArtifact returns a specified artifact.
  • PUTRegistry_ReplaceArtifact/v1/projects/:project/locations/:location/artifacts/:artifactReplaceArtifact can be used to replace a specified artifact.
  • DELETERegistry_DeleteArtifact/v1/projects/:project/locations/:location/artifacts/:artifactDeleteArtifact removes a specified artifact.
  • GETRegistry_GetArtifactContents/v1/projects/:project/locations/:location/artifacts/:artifact:getContentsGetArtifactContents returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the…

API details

Base URL
http://apigee.local
https://apigeeregistry.googleapis.com
Authentication
None declared in the description
Operations
35 operations on 20 pathsGET 14POST 9DELETE 7PATCH 4PUT 1
Main resources
Registry 35
Response formats
application/json */*
Description format
OpenAPI 3.0.3, API version 0.0.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Registry API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Registry API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Registry_ListApis” (GET /v1/projects/:project/locations/:location/apis?pageSize=0&pageToken=string&filter=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Registry API?

The Registry service allows teams to manage descriptions of APIs. It is listed under Developer tools and has 35 endpoints.

Who publishes the Registry API?

It is listed from Apigee's public API description (an OpenAPI document), not published by Apigee on Swastik Codes. Anyone who controls apigee.net can claim the profile by adding a DNS TXT record.

What is the base URL of the Registry API?

Its description lists 2 base URLs: http://apigee.local, https://apigeeregistry.googleapis.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Registry API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Registry API have?

35 operations on 20 paths (14 GET, 9 POST, 7 DELETE, 4 PATCH, 1 PUT). The largest groups are Registry.

Is forking the Registry API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.