APIHub
Back to Explore

Apigee Registry API

Apigee Registry API

Analytics
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/v1/{name}:cancel

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

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

/v1/{name}

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

  • name (path, required) — The name of the operation resource to be deleted.
  • force (query) — If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
GET

/v1/{name}

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.

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

/v1/{name}

Used to modify a specified spec.

  • name (path, required) — Resource name.
  • allowMissing (query) — If set to true, and the spec is not found, a new spec will be created. In this situation, `update_mask` is ignored.
  • updateMask (query) — 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.
PUT

/v1/{name}

Used to replace a specified artifact.

  • name (path, required) — Resource name.
GET

/v1/{name}/locations

Lists information about the supported locations for this service.

  • name (path, required) — The resource that owns the locations collection, if applicable.
  • filter (query) — 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).
  • pageSize (query, limit) — The maximum number of results to return. If not set, the service selects a default.
  • pageToken (query) — A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
GET

/v1/{name}/operations

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

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

/v1/{name}:deleteRevision

Deletes a revision of a spec.

  • name (path, required) — 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`
GET

/v1/{name}:getContents

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

  • name (path, required) — Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`
GET

/v1/{name}:listRevisions

Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.

  • name (path, required) — Required. The name of the spec to list revisions for.
  • filter (query) — An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
  • pageSize (query, limit) — The maximum number of revisions to return per page.
  • pageToken (query) — The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page.
POST

/v1/{name}:rollback

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

  • name (path, required) — Required. The spec being rolled back.
POST

/v1/{name}:tagRevision

Adds a tag to a specified revision of a spec.

  • name (path, required) — Required. The name of the spec to be tagged, including the revision ID.
GET

/v1/{parent}/apis

Returns matching APIs.

  • parent (path, required) — Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`
  • filter (query) — An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
  • orderBy (query) — 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"
  • pageSize (query, limit) — 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.
  • pageToken (query) — 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.
POST

/v1/{parent}/apis

Creates a specified API.

  • parent (path, required) — Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`
  • apiId (query) — 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.
GET

/v1/{parent}/artifacts

Returns matching artifacts.

  • parent (path, required) — Required. The parent, which owns this collection of artifacts. Format: `{parent}`
  • filter (query) — 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.
  • orderBy (query) — 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"
  • pageSize (query, limit) — 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.
  • pageToken (query) — 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.
POST

/v1/{parent}/artifacts

Creates a specified artifact.

  • parent (path, required) — Required. The parent, which owns this collection of artifacts. Format: `{parent}`
  • artifactId (query) — 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.
GET

/v1/{parent}/deployments

Returns matching deployments.

  • parent (path, required) — Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`
  • filter (query) — An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
  • orderBy (query) — 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"
  • pageSize (query, limit) — 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.
  • pageToken (query) — 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.
POST

/v1/{parent}/deployments

Creates a specified deployment.

  • parent (path, required) — Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`
  • apiDeploymentId (query) — 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.
POST

/v1/{parent}/instances

Provisions instance resources for the Registry.

  • parent (path, required) — Required. Parent resource of the Instance, of the form: `projects/*/locations/*`
  • instanceId (query) — Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
GET

/v1/{parent}/specs

Returns matching specs.

  • parent (path, required) — Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`
  • filter (query) — 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.
  • orderBy (query) — 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"
  • pageSize (query, limit) — 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.
  • pageToken (query) — 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.
POST

/v1/{parent}/specs

Creates a specified spec.

  • parent (path, required) — Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`
  • apiSpecId (query) — 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.
GET

/v1/{parent}/versions

Returns matching versions.

  • parent (path, required) — Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`
  • filter (query) — An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
  • orderBy (query) — 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"
  • pageSize (query, limit) — 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.
  • pageToken (query) — 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.
POST

/v1/{parent}/versions

Creates a specified version.

  • parent (path, required) — Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`
  • apiVersionId (query) — 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.
GET

/v1/{resource}:getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource (path, required) — 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 (query) — 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).
POST

/v1/{resource}:setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource (path, required) — 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.
POST

/v1/{resource}:testIamPermissions

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.

  • resource (path, required) — 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.

26 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://apigeeregistry.googleapis.com/v1/{name}:cancel"

apigeeregistry.googleapis.com · HTTPS only