Method: organizations.environments.archiveDeployments.generateUploadUrl

Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to archiveDeployments.create.

When uploading to the generated signed URL, please follow these restrictions:

  • Source file type should be a zip file.
  • Source file size should not exceed 1GB limit.
  • No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL.

When making a HTTP PUT request, these two headers need to be specified:

  • content-type: application/zip
  • x-goog-content-length-range: 0,1073741824

And this header SHOULD NOT be specified:

  • Authorization: Bearer YOUR_TOKEN

HTTP request

POST https://apigee.googleapis.com/v1/{parent=organizations/*/environments/*}/archiveDeployments:generateUploadUrl

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The organization and environment to upload to.

Authorization requires the following IAM permission on the specified resource parent:

  • apigee.archivedeployments.upload

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for archiveDeployments.generateUploadUrl method.

JSON representation
{
  "uploadUri": string
}
Fields
uploadUri

string

The Google Cloud Storage signed URL that can be used to upload a new Archive zip file.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform