getList

Available in VPC

Get the list of all accounts in Data Forest.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Data Forest APIs, see Data Forest request headers.

Request example

The request example is as follows:

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/accounts/getList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

Response

This section describes the response format.

Response body

See GetAccountListResponse for the response body.

Response status codes

For information about the HTTP status codes common to all Data Forest APIs, see Data Forest response status codes.

Response example

The response example is as follows:

{
    "success": true,
    "total": 1,
    "contents": [
        {
            "id": "Arv**************kfn",
            "name": "df001",
            "principal": "df001@KR.DF.NAVERNCP.COM",
            "status": "RUNNING",
            "createdAt": "2025-02-20T09:32:55+09:00",
            "disabled": false
        }
    ]
}