Method: projects.image.importExternal

  • Imports an external image into Google Earth Engine using an HTTP POST request.

  • Requires authorization with specific IAM permissions or OAuth scopes.

  • Users provide an image manifest and can specify whether to overwrite existing assets.

  • The request body includes the image manifest and an overwrite option, while a successful response body is empty.

  • The API uses gRPC Transcoding and requires specifying the Google Cloud project ID in the URL.

Imports an external image.

HTTP request

POST https://earthengine.googleapis.com/v1alpha/{project=projects/*}/image:importExternal

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

The project id or project number of the Google Cloud Platform project that should be treated as the service consumer for this request. Format is projects/{project-id}.

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

  • earthengine.imports.create

Request body

The request body contains data with the following structure:

JSON representation
{
  "imageManifest": {
    object (ImageManifest)
  },
  "overwrite": boolean
}
Fields
imageManifest

object (ImageManifest)

The image manifest.

overwrite

boolean

Whether to allow overwriting an existing asset.

Response body

If successful, the response body is empty.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.