Sign in

v1

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

Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.

post/v1/{+parent}/deployments

Path parameters

parentstring required

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

Query parameters

deploymentIdstring

Optional. The ID to use for the deployment resource, which will become the final component of the deployment'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 deployment 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

endpointsstring[]

Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.

apiVersionsstring[]

Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).

displayNamestring

Required. The display name of the deployment.

resourceUristring

Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name orders is deployed in staging environment of cymbal organization, the resource URI would be: organizations/cymbal/environments/staging/apis/orders.

descriptionstring

Optional. The description of the deployment.

attributesobject

Optional. The list of user defined attributes associated with the deployment 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. The name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

updateTimestring google-datetime

Output only. The time at which the deployment was last updated.

createTimestring google-datetime

Output only. The time at which the deployment was created.

sourceProjectstring

Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.

sourceEnvironmentstring

Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.

Response

Successful response