projects

POST /v1/projects/{projectsId}/locations/{locationsId}/deployments

Changed on Nov 8, 2026

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

Request

Base URL
https://apihub.googleapis.com
Auth
- OAuth 2 and OAuth 2
  Implicithttps://accounts.google.com/o/oauth2/auth
  Scopeshttps://www.googleapis.com/auth/apihub.readwrite
  Authorization codehttps://accounts.google.com/o/oauth2/auth
  Token URLhttps://accounts.google.com/o/oauth2/token
  Scopeshttps://www.googleapis.com/auth/apihub.readwrite
- or OAuth 2 and OAuth 2
  Implicithttps://accounts.google.com/o/oauth2/auth
  Scopeshttps://www.googleapis.com/auth/cloud-platform
  Authorization codehttps://accounts.google.com/o/oauth2/auth
  Token URLhttps://accounts.google.com/o/oauth2/token
  Scopeshttps://www.googleapis.com/auth/cloud-platform
TypeScript
https://skmtc.dev/google/apis/apihub/docs/v1/projects/:projectsId/locations/:locationsId/deployments/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectsIdstring required

locationsIdstring required

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

apiOperationsstring[]

Output only. The API operations linked directly to this deployment.

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

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.

createTimestring google-datetime

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

descriptionstring

Optional. The description of the deployment.

displayNamestring

Required. The display name of the deployment.

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.

namestring

Identifier. The name of the deployment. Format: projects/{project}/locations/{location}/deployments/{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.

sourceEnvironmentstring

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

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.

sourceRevisionstring

Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered.

specsstring[]

Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration).

updateTimestring google-datetime

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

Response

Successful response