Set API authentication key

Available in VPC

Set up an API authentication key to access the Object Storage service.

Request

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

Request headers

For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.

Request path parameters

You can use the following path parameters with your request:

Request body

You can include the following data in the body of your request:

Request example

The request example is as follows:

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/updateAPIAuthenticationKey/1037*****' \
--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' \
--data '{
    "accessKeyId": "{Access Key}",
    "secretKey": "{Secret Key}"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.

Response example

The response example is as follows:

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "c1637182-****-****-****-f83000f29695"
}