Available in Classic and VPC
Delete an application target assigned to a server or service role.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
DELETE | /api/v1/roles/{roleNo}/entities |
Request headers
For information about the headers common to all Sub Account APIs, see Sub Account request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
roleNo |
String | Required | Role ID
|
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
entityIdList |
Array | Required | Role application target list
|
Request example
The request example is as follows:
curl --location --request DELETE 'https://subaccount.apigw.ntruss.com/api/v1/roles/5befa3a0-****-****-****-246e96591a38/entities' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--data '{
"entityIdList": [
"100****57"
]
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
success |
Boolean | - | API call success status
|
id |
String | - | Role application target ID or name |
name |
String | - | Action type |
Response status codes
For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.
Response example
The response example is as follows:
[
{
"success": true,
"id": "100****57",
"name": "removeEntity"
}
]