--- title: "Data Forest overview" slug: "analytics-dataforest" tags: ["Data Forest", "overview"] updated: 2026-09-17T09:47:59Z published: 2026-09-17T09:47:59Z canonical: "api.ncloud-docs.com/analytics-dataforest" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # Data Forest overview Available in VPC Data Forest is a NAVER Cloud Platform big data analytics platform service that provides a variety of open source applications from big data analysis to machine learning. The Data Forest service provides APIs for Data Forest accounts and app features in the RESTful form. ## Common Data Forest settings The following describes commonly used request and response formats in Data Forest APIs. ### Request The following describes the common request format. #### API URL The request API URL is as follows: ``` https://df.apigw.ntruss.com ``` #### Request headers The following describes the headers. | Header name | Required | Description | | --- | --- | --- | | `x-ncp-apigw-timestamp` | Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. - Request is considered invalid if the timestamp differs from the current time by more than 5 minutes. - Unix timestamp format | | `x-ncp-iam-access-key` | Required | Access key issued on NAVER Cloud Platform - Issue and check access key: See [Create authentication key](/docs/en/common-ncpapi). - Issue and check access key for sub account: See [Create sub account](https://guide.ncloud-docs.com/docs/en/subaccount-use#%EC%84%9C%EB%B8%8C-%EA%B3%84%EC%A0%95-%EC%83%9D%EC%84%B1). | | `x-ncp-apigw-signature-v2` | Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256) - Issue and check secret key: See [Create authentication key](/docs/en/common-ncpapi). - Create signature: See [Create signature](/docs/en/common-ncpapi). | | `Accept` | Optional | Response data format - `application/json` \| `application/xml` \| `application/octet-stream` | | `Content-type` | Optional | Request data format - `application/json` \| `application/xml` | ### Response The following describes the common response format. #### Response body The response body includes the following data: **ErrorResponse** ErrorResponse defines API call failure information. The following describes ErrorResponse. | Field | Type | Required | Description | | --- | --- | --- | --- | | `message` | String | Required | Error message | | `success` | Boolean | Required | API processing result - `false`: failure (valid value) | #### Response status codes The following describes the response status codes. | HTTP status code | Code | Message | Description | | --- | --- | --- | --- | | 400 | - | exceeded limit on resource quota | Creation limit exceeded. - Contact [**Support**](https://www.ncloud.com/support/question/service) from the NAVER Cloud Platform portal. | | 400 | - | invalid request parameters | Parameter input error | | 403 | - | not allowed to access | Unauthorized request. - Add permissions to the account or use appropriate credentials. | | 404 | - | no such element | Queried a non-existent resource or path. - Check the input value and enter the correct resource or path. | | 500 | - | unexpected error | Unknown error occurred. - Contact [**Support**](https://www.ncloud.com/support/question/service) from the NAVER Cloud Platform portal. | Note For response status codes common to NAVER Cloud Platform, see [Ncloud API response status codes](/docs/en/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C). #### Response example For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call. - JSON ``` { "error": { "message": "string", "success": "false" } } ``` - XML ``` string false ``` ## Data Forest API The following describes the APIs provided by the Data Forest service. ### Accounts The following describes the APIs related to Data Forest account. | API | Description | | --- | --- | | [checkAvailableName](/docs/en/analytics-dataforest-accounts-checkavailablename) | Check validity and duplication of Data Forest account name. | | [create](/docs/en/analytics-dataforest-accounts-create) | Create Data Forest account. | | [getList](/docs/en/analytics-dataforest-accounts-getlist) | Get Data Forest account list. | | [getDetail](/docs/en/analytics-dataforest-accounts-getdetail) | Get details of a single Data Forest account. | | [checkHasResource](/docs/en/analytics-dataforest-accounts-checkhasresource) | Check the existence of resources owned by a Data Forest account. | | [getKerberosKeytab](/docs/en/analytics-dataforest-accounts-getkerberoskeytab) | Download Kerberos Keytab. | | [resetKerberosKeytab](/docs/en/analytics-dataforest-accounts-resetkerberoskeytab) | Reset Kerberos Keytab. | | [resetPassword](/docs/en/analytics-dataforest-accounts-resetpassword) | Reset the Data Forest account password. | | [setQuota](/docs/en/analytics-dataforest-accounts-setquota) | Change HDFS quota for a Data Forest account. | | [delete](/docs/en/analytics-dataforest-accounts-delete) | Delete an Data Forest account. | ### Apps The following describes the APIs related to Data Forest app. | API | Description | | --- | --- | | [checkAvailableName](/docs/en/analytics-dataforest-apps-checkAvailablename) | Check validity and duplication of Data Forest app name. | | [getAppBasicSetting](/docs/en/analytics-dataforest-apps-getappbasicsetting) | Get Data Forest app type basic settings. | | [getAppTypeIdList](/docs/en/analytics-dataforest-apps-getapptypeidlist) | Get the list of Data Forest app type IDs. | | [getAppTypeTemplate](/docs/en/analytics-dataforest-apps-getapptypetemplate) | Get Data Forest app type template information. | | [create](/docs/en/analytics-dataforest-apps-create) | Create Data Forest app | | [getList](/docs/en/analytics-dataforest-apps-getlist) | Get the list of apps in a Data Forest account. | | [getDetail](/docs/en/analytics-dataforest-apps-getdetail) | Get details of a single Data Forest app. | | [setContainerCount](/docs/en/analytics-dataforest-apps-setcontainercount) | Change number of Data Forest app component containers. | | [setLifetime](/docs/en/analytics-dataforest-apps-setlifetime) | Change Data Forest app lifetime. | | [killContainer](/docs/en/analytics-dataforest-apps-killcontainer) | Restart Data Forest app component container. | | [killMaster](/docs/en/analytics-dataforest-apps-killmaster) | Restart Data Forest app application master. | | [start](/docs/en/analytics-dataforest-apps-start) | Start the Data Forest app. | | [stop](/docs/en/analytics-dataforest-apps-stop) | Stop the Data Forest app. | | [delete](/docs/en/analytics-dataforest-apps-delete) | Delete the Data Forest app. | ## Data Forest related resources NAVER Cloud Platform provides a variety of related resources to help users better understand Data Forests. - Data Forest API guides - [Create signature](/docs/en/common-ncpapi): how to create a signature to add to the request header - [API Gateway User Guide](https://guide.ncloud-docs.com/docs/en/apigw-apigw-1): how to issue the API key to be added to the request header - [Sub Account User Guide](https://guide.ncloud-docs.com/docs/en/subaccount-overview): how to issue the access key to be added to the request header - [Common Ncloud response status codes](/docs/en/common-ncpapi#3-%EC%9D%91%EB%8B%B5-%EC%83%81%ED%83%9C-%EC%BD%94%EB%93%9C): information on common response status codes of NAVER Cloud Platform used by the Data Forest service - How to use the Data Forest service - [Data Forest User Guide](https://guide.ncloud-docs.com/docs/en/df-overview): how to use Data Forest in the NAVER Cloud Platform console - [Ncloud use environment guide](https://guide.ncloud-docs.com/docs/en/environment-environment-1-1): guide for VPC and Classic environments and support availability - [Introduction to pricing, characteristics, and detailed features](https://www.ncloud.com/product/analytics/dataForest): the summary of pricing system, characteristics, and detailed features of Data Forest - [Latest service news](https://www.ncloud.com/intro/news): the latest news on the Data Forest service - [FAQ](https://www.ncloud.com/support/faq/prod?categoryCode2=ANALY&categoryCode3=SV_0183&page=1): frequently asked questions from the Data Forest service users - [Contact us](https://www.ncloud.com/support/question/general): Send direct inquiries for unresolved questions that aren't answered by the API guide