Sign in
Registry

CreateApiVersion creates a specified version.

post/v1/projects/{project}/locations/{location}/apis/{api}/versions

Path parameters

projectstring required

The project id.

locationstring required

The location id.

apistring required

The api id.

Query parameters

apiVersionIdstring

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.

Request body

namestring

Resource name.

displayNamestring

Human-meaningful name.

descriptionstring

A detailed description.

createTimestring date-time

Output only. Creation timestamp.

updateTimestring date-time

Output only. Last update timestamp.

statestring

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

labelsobject

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.

annotationsobject

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.

Response

OK

namestring

Resource name.

displayNamestring

Human-meaningful name.

descriptionstring

A detailed description.

createTimestring date-time

Output only. Creation timestamp.

updateTimestring date-time

Output only. Last update timestamp.

statestring

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

labelsobject

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.

annotationsobject

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.

Changes

Changed in 4 of the 14 revisions of this API.557

  • 60e792df40884See the full diff
    • ▲

      the request's body type changed from no type to object

      request-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's property format changed from RFC3339 to date-time for status

      response-property-type-changed

    • ▲

      the response's property format changed from RFC3339 to date-time for status

      response-property-type-changed

  • ce92b3e601d456See the full diff
    • ●

      deleted the query request parameter api_version_id

      request-parameter-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      api tag Registry added

      api-tag-added

    • ○

      added the new optional query request parameter apiVersionId

      new-optional-request-parameter

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2699b7373a241See the full diff
    • ○

      endpoint added

      endpoint-added

  • 9c2571d516e81See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog