Method: projects.locations.apps.importApp

Imports the specified app.

HTTP request

POST https://ces.googleapis.com/v1beta/{parent=projects/*/locations/*}/apps:importApp

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name with the location of the app to import.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "displayName": string,
  "appId": string,
  "importOptions": {
    object (ImportAppRequest.ImportOptions)
  },

  // Union field app can be only one of the following:
  "gcsUri": string,
  "appContent": string
  // End of list of possible types for union field app.
}
Fields
displayName

string

Optional. The display name of the app to import. * If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. * If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.
appId

string

Optional. The ID to use for the imported app. * If not specified, a unique ID will be automatically assigned for the app. * Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.
importOptions

object (ImportAppRequest.ImportOptions)

Optional. Options governing the import process for the app.
Union field app. The app to import. app can be only one of the following:
gcsUri

string

The Google Cloud Storage URI from which to import app. The format of this URI must be gs://<bucket-name>/<object-name>.
appContent

string (bytes format)

Raw bytes representing the compressed zip file with the app folder structure.

A base64-encoded string.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • ces.apps.import

For more information, see the IAM documentation.

ImportAppRequest.ImportOptions

Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.

JSON representation 
{
  "conflictResolutionStrategy": enum (ImportAppRequest.ImportOptions.ConflictResolutionStrategy)
}
Fields
conflictResolutionStrategy

enum (ImportAppRequest.ImportOptions.ConflictResolutionStrategy)

Optional. The strategy to use when resolving conflicts during import.

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

Defines the strategy for handling conflicts when an app with the same ID already exists, or when imported resources (like Agents, Tools, etc.) have the same display names as existing resources within that app.

Enums
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED The conflict resolution strategy is unspecified.
REPLACE Replace existing data with imported data. If an app with the same appId already exists, its content will be updated based on the imported app. - Resources (App, Agents, Tools, Examples, Guardrails, Toolsets) in the imported app that have the same display name as existing resources will overwrite the existing ones. - Imported resources with new display names will be created. - Existing resources that do not have a matching display name in the imported app will remain untouched.
OVERWRITE Overwrite existing data with imported data. If an app with the same appId already exists, its content will be overwritten with the imported app. - Existing resources (Agents, Tools, Examples, Guardrails, Toolsets) in the app will be deleted. - Imported resources will be created as new resources.