Sign in

v1

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

Create an External API resource in the API hub.

post/v1/{+parent}/externalApis

Path parameters

parentstring required

Required. The parent resource for the External API resource. Format: projects/{project}/locations/{location}

Query parameters

externalApiIdstring

Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.

Request body

updateTimestring google-datetime

Output only. Last update timestamp.

createTimestring google-datetime

Output only. Creation timestamp.

descriptionstring

Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).

attributesobject

Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

namestring

Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}.

endpointsstring[]

Optional. List of endpoints on which this API is accessible.

displayNamestring

Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).

pathsstring[]

Optional. List of paths served by this API.

Response

Successful response