Method: projects.locations.products.integrations.versions.archive

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the lockedBy user is not the same as the user performing the Archive. Audit fields updated include lastModifiedTimestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.

HTTP request

POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*/products/apigee/integrations/*/versions/*}:archive

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The version to archive. Format: projects/{project}/integrations/{integration}/versions/{version}

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires one of the following IAM permissions on the name resource, depending on the resource type:

  • integrations.apigeeIntegrationVers.deploy
  • integrations.securityIntegrationVers.deploy

For more information, see the IAM documentation.