BlacklistApi


Delete a Blocking condition

Delete a Blocking condition\n

URL

https://apis.wso2.com/api/am/admin/v0.10/throttling/blacklist/{conditionId}

HTTP Method

DELETE

Scope

apim:bl_manage

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Path

conditionId

required

Blocking condition identifier \n

String

Header

If-Match

optional

Validator for conditional requests; based on ETag.\n

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.\n

String

Responses

HTTP Code Description Schema

200

OK.\nResource successfully deleted.\n

404

Not Found.\nResource to be deleted does not exist.\n

Error

412

Precondition Failed.\nThe request has not been performed because one of the preconditions is not met.\n

Error

Retrieve a Blocking Condition

Retrieve a Blocking Condition providing the condition Id\n

URL

https://apis.wso2.com/api/am/admin/v0.10/throttling/blacklist/{conditionId}

HTTP Method

GET

Scope

apim:bl_view

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Path

conditionId

required

Blocking condition identifier \n

String

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved\nvariant of the resourec.\n

String

Header

If-Modified-Since

optional

Validator for conditional requests; based on Last Modified header of the\nformerly retrieved variant of the resource.\n

String

Responses

HTTP Code Description Schema

200

OK.\nCondition returned\n

BlockingCondition

304

Not Modified.\nEmpty body because the client has already the latest version of the requested resource.\n

404

Not Found.\nRequested Condition does not exist.\n

Error

406

Not Acceptable.\nThe requested media type is not supported.\n

Error

Get all blocking condtions

Get all blocking condtions\n

URL

https://apis.wso2.com/api/am/admin/v0.10/throttling/blacklist

HTTP Method

GET

Scope

apim:bl_view

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Header

Accept

optional

Media types acceptable for the response. Default is JSON.\n

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved\nvariant of the resourec.\n

String

Header

If-Modified-Since

optional

Validator for conditional requests; based on Last Modified header of the\nformerly retrieved variant of the resource.\n

String

Responses

HTTP Code Description Schema

200

OK.\nBlocking conditions returned\n

BlockingConditionList

304

Not Modified.\nEmpty body because the client has already the latest version of the requested resource.\n

406

Not Acceptable.\nThe requested media type is not supported.\n

Error

Add a Blocking condition

Add a Blocking condition\n

URL

https://apis.wso2.com/api/am/admin/v0.10/throttling/blacklist

HTTP Method

POST

Scope

apim:bl_manage

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Body

body

required

Blocking condition object that should to be added\n

BlockingCondition (BlockingCondition)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.\n

String

JSON

Responses

HTTP Code Description Schema

201

Created.\nSuccessful response with the newly created object as entity in the body.\nLocation header contains URL of newly created entity.\n

BlockingCondition

400

Bad Request.\nInvalid request or validation error\n

Error

415

Unsupported media type.\nThe entity of the request was in a not supported format.\n