Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
Method: projects.image.import
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://earthengine.googleapis.com/v1alpha/{project=projects/*}/image:import
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)
},
"description": string,
"overwrite": boolean,
"requestId": string
} |
| Fields |
imageManifest |
object (ImageManifest)
The image manifest.
|
description |
string
A human-readable name of the task.
|
overwrite |
boolean
Whether to allow overwriting an existing asset.
|
requestId |
string
A unique string used to detect duplicated requests. If more than one request is made by the same user with the same non-empty requestId, only one of those requests may successfully start a long-running operation. requestId may contain the characters a..z, A..Z, 0-9, or '-'. requestId may be at most 60 characters long.
|
Response body
If successful, the response body contains an instance of Operation.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-06 UTC.
[null,null,["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eImports an image into Earth Engine using an HTTP POST request.\u003c/p\u003e\n"],["\u003cp\u003eRequires specifying an image manifest, description, overwrite option, and optional request ID.\u003c/p\u003e\n"],["\u003cp\u003eUsers need \u003ccode\u003eearthengine.imports.create\u003c/code\u003e permission on the specified Google Cloud project.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an Operation object to track the import progress.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication requires specific OAuth scopes like \u003ccode\u003ehttps://www.googleapis.com/auth/earthengine\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],["This content outlines how to import an image using an HTTP POST request to the Earth Engine API. The request uses the URL `https://earthengine.googleapis.com/v1alpha/{project=projects/*}/image:import`, requiring `earthengine.imports.create` IAM permission. The request body must include `imageManifest`, `description`, `overwrite` and optionally a `requestId`. A successful request returns an `Operation`. OAuth scopes for authorization include `earthengine` or `cloud-platform`.\n"],null,["# Method: projects.image.import\n\nImports an image.\n\n### HTTP request\n\n`POST https://earthengine.googleapis.com/v1alpha/{project=projects/*}/image:import`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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](https://cloud.google.com/iam/docs/) permission on the specified resource `project`: - `earthengine.imports.create` |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"imageManifest\": { object (/earth-engine/reference/rest/v1alpha/ImageManifest) }, \"description\": string, \"overwrite\": boolean, \"requestId\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `imageManifest` | `object (`[ImageManifest](/earth-engine/reference/rest/v1alpha/ImageManifest)`)` The image manifest. |\n| `description` | `string` A human-readable name of the task. |\n| `overwrite` | `boolean` Whether to allow overwriting an existing asset. |\n| `requestId` | `string` A unique string used to detect duplicated requests. If more than one request is made by the same user with the same non-empty `requestId`, only one of those requests may successfully start a long-running operation. `requestId` may contain the characters a..z, A..Z, 0-9, or '-'. `requestId` may be at most 60 characters long. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/earth-engine/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/earthengine`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]