Sign in

v1

latestOpenAPI 3.0.32026-07-13351892.0 KB
Registry

CreateApi creates a specified API.

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

Path parameters

projectstring required

The project id.

locationstring required

The location id.

Query parameters

apiIdstring

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.

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.

availabilitystring

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

recommendedVersionstring

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

recommendedDeploymentstring

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

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.

availabilitystring

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

recommendedVersionstring

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

recommendedDeploymentstring

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

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.