Check profile name

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in Classic and VPC

Check validity and duplication status of a profile name.

Request

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

Request headers

For information about the headers common to all Global Edge APIs, see Global Edge request headers.

Request query parameters

You can use the following query parameters with your request:

Request example

The request example is as follows:

curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/profiles/validation?name=profilename-test' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For information about the HTTP status codes common to all Global Edge APIs, see Global Edge response status codes.

Response example

The response example is as follows:

If check result is available name

The following is a sample response if the check result is an available name.

{
    "code": "0000",
    "message": "Success",
    "result": false
}

If check result is unavailable name

The following is a sample response if the check result is an unavailable name.

• If the profile name already exists

  {
      "code": "0000",
      "message": "Success",
      "result": true
  }
  

• If the profile name is invalid

  {
      "traceId": "32ohg69i6aphn36d1lccr3adhk",
      "path": "/v1/external/profiles/validation",
      "timestamp": 1752547449310,
      "product": "Global Edge",
      "status": 400,
      "code": "0040",
      "message": "Field validation Error",
      "details": "existsProfileName.name=my : size must be between 3 and 35"
  }