Available in VPC
Check validity and duplication status of a Data Forest group name.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v2/apps/checkAvailableName |
Request headers
For information about the headers common to all Data Forest APIs, see Data Forest request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
accountId |
String | Required | Account's unique identifier
|
name |
String | Required | App name
|
Request example
The request example is as follows:
curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/checkAvailableName' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"accountId": "Arv**************kfn",
"name": "dev24x7"
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
success |
Boolean | - | API processing result
|
message |
String | - | Result message
|
availableName |
Boolean | - | Whether the app name is valid
|
Response status codes
For response status codes common to all Data Forest APIs, see Data Forest response status codes.
Response example
The response example is as follows:
{
"success": true,
"availableName": true
}