Protocol Documentation

Resource name.

Human-meaningful name.

A detailed description.

Output only. Creation timestamp.

Output only. Last update timestamp.

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g. "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

The recommended version of the API. Format: apis/{api}/versions/{version}

The recommended deployment of the API. Format: apis/{api}/deployments/{deployment}

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

Resource name.

Human-meaningful name.

A detailed description.

Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

Output only. Creation timestamp; when the deployment resource was created.

Output only. Revision creation timestamp; when the represented revision was created.

Output only. Last update timestamp: when the represented revision was last modified.

The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

The address where the deployment is serving. Changes to this value will update the revision.

The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "registry.googleapis.com/" and cannot be changed.

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

Resource name.

A possibly-hierarchical name used to refer to the spec from other specs.

A detailed description.

Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string.

Output only. Creation timestamp; when the spec resource was created.

Output only. Revision creation timestamp; when the represented revision was created.

Output only. Last update timestamp: when the represented revision was last modified.

A style (format) descriptor for this spec that is specified as a Media Type (https://en.wikipedia.org/wiki/Media_type). Possible values include "application/vnd.apigee.proto", "application/vnd.apigee.openapi", and "application/vnd.apigee.graphql", with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").

Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.

Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.

The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.

Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

Resource name.

Human-meaningful name.

A detailed description.

Output only. Creation timestamp.

Output only. Last update timestamp.

A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g. "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED".

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

Resource name.

Output only. Creation timestamp.

Output only. Last update timestamp.

A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").

Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.

Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.

Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.

Required. The parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/*

Required. The deployment to create.

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][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.

Required. The parent, which owns this collection of APIs. Format: projects/*/locations/*

Required. The API to create.

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][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.

Required. The parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*

Required. The spec to create.

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][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.

Required. The parent, which owns this collection of versions. Format: projects/*/locations/*/apis/*

Required. The version to create.

Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.

Required. The parent, which owns this collection of artifacts. Format: {parent}

Required. The artifact to create.

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][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.

Required. The name of the deployment to delete. Format: projects/*/locations/*/apis/*/deployments/*

If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

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

Required. The name of the API to delete. Format: projects/*/locations/*/apis/*

If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

Required. The name of the spec to delete. Format: projects/*/locations/*/apis/*/versions/*/specs/*

If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

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

Required. The name of the version to delete. Format: projects/*/locations/*/apis/*/versions/*

If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

Required. The name of the artifact to delete. Format: {parent}/artifacts/*

Required. The name of the deployment to retrieve. Format: projects/*/locations/*/apis/*/deployments/*

Required. The name of the API to retrieve. Format: projects/*/locations/*/apis/*

Required. The name of the spec whose contents should be retrieved. Format: projects/*/locations/*/apis/*/versions/*/specs/*

Required. The name of the spec to retrieve. Format: projects/*/locations/*/apis/*/versions/*/specs/*

Required. The name of the version to retrieve. Format: projects/*/locations/*/apis/*/versions/*

Required. The name of the artifact whose contents should be retrieved. Format: {parent}/artifacts/*

Required. The name of the artifact to retrieve. Format: {parent}/artifacts/*

Required. The name of the deployment to list revisions for.

The maximum number of revisions to return per page.

The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page.

The revisions of the deployment.

A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Required. The parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/*

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.

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.

An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

The deployments from the specified publisher.

A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Required. The name of the spec to list revisions for.

The maximum number of revisions to return per page.

The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page.

The revisions of the spec.

A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Required. The parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*

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.

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.

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.

The specs from the specified publisher.

A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Required. The parent, which owns this collection of versions. Format: projects/*/locations/*/apis/*

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.

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.

An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

The versions from the specified publisher.

A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Required. The parent, which owns this collection of APIs. Format: projects/*/locations/*

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.

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.

An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

The APIs from the specified publisher.

A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Required. The parent, which owns this collection of artifacts. Format: {parent}

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.

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.

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.

The artifacts from the specified publisher.

A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Required. The artifact to replace. The `name` field is used to identify the artifact to replace. Format: {parent}/artifacts/*

Required. The deployment being rolled back.

Required. The revision ID to roll back to. It must be a revision of the same deployment. Example: c7cfa2a8

Required. The spec being rolled back.

Required. The revision ID to roll back to. It must be a revision of the same spec. Example: c7cfa2a8

Required. The name of the deployment to be tagged, including the revision ID.

Required. The tag to apply. The tag should be at most 40 characters, and match `[a-z][a-z0-9-]{3,39}`.

Required. The name of the spec to be tagged, including the revision ID.

Required. The tag to apply. The tag should be at most 40 characters, and match `[a-z][a-z0-9-]{3,39}`.

Required. The deployment to update. The `name` field is used to identify the deployment to update. Format: projects/*/locations/*/apis/*/deployments/*

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 a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored.

Required. The API to update. The `name` field is used to identify the API to update. Format: projects/*/locations/*/apis/*

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 a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

If set to true, and the api is not found, a new api_versions will be created. In this situation, `update_mask` is ignored.

Required. The spec to update. The `name` field is used to identify the spec to update. Format: projects/*/locations/*/apis/*/versions/*/specs/*

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 a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

If set to true, and the spec is not found, a new spec will be created. In this situation, `update_mask` is ignored.

Required. The version to update. The `name` field is used to identify the version to update. Format: projects/*/locations/*/apis/*/versions/*

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 a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

If set to true, and the version is not found, a new version will be created. In this situation, `update_mask` is ignored.

Version of Go that produced this binary.

The main package path.

The main module.

The dependencies of the build.

Settings associated with the build.

The module path.

The module version.

The module checksum.

An optional replacement for the module

Resource name.

Human-meaningful name.

A detailed description.

Creation timestamp.

Last update timestamp.

A string describing the status.

Information about the build of the server.

A string describing the storage backend.

A list of collections in the storage backend. Collections are listed in alphabetical order.

The name of the collection.

The number of entries in the collection.

The project to create.

The ID to use for the project, which will become the final component of the project's resource name. This value should be at most 80 characters, and valid characters are /[a-z][0-9]-./.

The name of the project to delete. Format: projects/*

If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

The name of the project to retrieve. Format: projects/*

The maximum number of projects 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.

A page token, received from a previous `ListProjects` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProjects` must match the call that provided the page token.

An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

The projects from the specified publisher.

A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

A string describing the kind of migration to perform. Currently only "auto" is recognized (and is the default if omitted).

A string describing the result of the migration.

The project to update. The `name` field is used to identify the project to update. Format: projects/*

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 a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

If set to true, and the project is not found, a new project will be created. In this situation, `update_mask` is ignored.