Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13263478.2 KB
projects

Creates a specified API.

post/v1/{+parent}/apis

Path parameters

parentstring required

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

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

Request body

namestring

Resource name.

updateTimestring google-datetime

Output only. Last update timestamp.

displayNamestring

Human-meaningful name.

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

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.

recommendedDeploymentstring

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

createTimestring google-datetime

Output only. Creation timestamp.

recommendedVersionstring

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

descriptionstring

A detailed description.

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.

Response

Successful response