Add ACL Rule
- Print
- PDF
Add ACL Rule
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Add an IP address to the access control list to allow token requests.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /keys/{keyTag}/acl |
Request headers
For information about the headers common to all Key Management Service APIs, see the account authentication method in Key Management Service request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
keyTag | String | Required | Key tag
|
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
ipList | Array<String> | Required | IPv4 format IP address |
Request example
The request example is as follows:
curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/acl' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"ipList": [
"xxx.xxx.xxx.xxx"
]
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
code | String | - | Success or Failure |
data | Object | - | Response result |
data.keyTag | String | - | Tag for the key to which the IP address is added |
data.allowedIpList | Array<String> | - | List of allowed IP addresses |
Response status codes
For response status codes common to all Key Management Service APIs, see Key Management Service response status codes.
Response example
The response example is as follows:
{
"code": "SUCCESS",
"data": {
"keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"allowedIpList": [
"xxx.xxx.xxx.xxx"
]
}
}
Was this article helpful?