Change API key status
- Print
- PDF
Change API key status
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Change the status of a specified API key.Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| PATCH | /products/{product-id}/api-keys/{api-key-id} |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
product-id | String | Required | Product ID that the API key belongs to
|
api-key-id | String | Required | API key ID whose status you want to change
|
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
status | String | Required | Status to change to
|
Request example
The following is a sample request.
curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/api-keys/***fmy2***' \
--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 '{
"status" : "ACCEPTED"
}'
Response
The following describes the response format.
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.
Was this article helpful?