nav-img
Advanced

Downloading Export Files

Function

This API is used to download export files.

URI

GET /v5/{project_id}/download/{file_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

file_id

Yes

String

File ID.

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

region

Yes

String

Region Id

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

-

String

Example Requests

Download the exported file based on file_id.

GET https://{endpoint}/v5/{project_id}/download/{file_id}?enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
"zipfile content" : null
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes