Blacklist


Delete a Blocking condition
DELETE https://apis.wso2.com/api/am/admin/v0.12/throttling/blacklist/{conditionId}

Delete a Blocking condition

OAuth 2.0 Scope

apim:bl_managei

Request

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

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Path

conditionId

required

Blocking condition identifier

String

Header

If-Match

optional

Validator for conditional requests; based on ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Resource successfully deleted.

404

Not Found. Resource to be deleted does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Retrieve a Blocking Condition
GET https://apis.wso2.com/api/am/admin/v0.12/throttling/blacklist/{conditionId}

Retrieve a Blocking Condition providing the condition Id

OAuth 2.0 Scope

apim:bl_viewi

Request

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

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Path

conditionId

required

Blocking condition identifier

String

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec.

String

Header

If-Modified-Since

optional

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

String

Responses

HTTP Code Description Schema

200

OK. Condition returned

BlockingCondition

304

Not Modified. Empty body because the client has already the latest version of the requested resource.

404

Not Found. Requested Condition does not exist.

Error

406

Not Acceptable. The requested media type is not supported.

Error

Get all blocking condtions
GET https://apis.wso2.com/api/am/admin/v0.12/throttling/blacklist

Get all blocking condtions

OAuth 2.0 Scope

apim:bl_viewi

Request

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

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Header

Accept

optional

Media types acceptable for the response. Default is JSON.

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec.

String

Header

If-Modified-Since

optional

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

String

Responses

HTTP Code Description Schema

200

OK. Blocking conditions returned

BlockingConditionList

304

Not Modified. Empty body because the client has already the latest version of the requested resource.

406

Not Acceptable. The requested media type is not supported.

Error

Add a Blocking condition
POST https://apis.wso2.com/api/am/admin/v0.12/throttling/blacklist

Add a Blocking condition

OAuth 2.0 Scope

apim:bl_managei

Request

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

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Body

body

required

Blocking condition object that should to be added

BlockingCondition (BlockingCondition)

Header

Content-Type

required

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

String

JSON

Responses

HTTP Code Description Schema

201

Created. Successful response with the newly created object as entity in the body. Location header contains URL of newly created entity.

BlockingCondition

400

Bad Request. Invalid request or validation error

Error

415

Unsupported media type. The entity of the request was in a not supported format.