Updated on 2026-09-07 GMT+08:00

Downloading a File

Function

This API is used to download a file.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

POST /v5/{project_id}/download

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Definition MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. Constraints N/A Range application/json Default Value application/json
X-Auth-Token	Yes	String	Definition User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints Specify the request language type based on the supported languages. Range en-us: English zh-cn: Chinese es-us: Spanish pt-br: Portuguese Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
files	Yes	Array of strings	Definition Name of the file to be downloaded. Constraints The name of the file to be downloaded must be obtained through the showFiles API (used for querying downloadable files). Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
-	File	Definition Downloaded file. Constraints N/A Range N/A

Example Request

Downloading a file

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/download 
 
{ 
  "files" : [ "2e69ebb1-f06d-4eb2-a789-2883629jb204_postgresql_20250704024811.xlsx" ] 
}

Example Response

Status code: 200

""

Status Code

Status Code	Description
200	OK

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Task Operations