Endpoints - Accounting - White & Black Lists

White&Black Lists

This class of endpoints contains methods to alter master-key ONLY related settings. There are different models in this section and they’ll be described when necessary.

Some fields are maked as optional as in they don’t need to be present in a minimum working call.

 

GET /account/domainwhitelist

Retrieve the list of domains in whitelist for the DDU feature.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: Array of

DomainEntity {

domain (string): The domain,

hash (string): An hash for this element (used in GET/DELETE operations) [READ ONLY]

}



Filters:

  • offset [optional] [string, 0] : Where to start when retrieving domains

  • limit [optional] [integer, 20] : Maximum elements to retrieve

 

POST /account/domainwhitelist

Add a new domain in the whitelist.

Input: DomainEntity

Result: DomainEntity or Error

 

GET /account/domainwhitelist/{hash}

Retrieve a domain from the whitelist using {hash}.

Result: DomainEntity

 

DELETE /account/domainwhitelist/{hash}

Remove whitelist domain using {hash}.

Result: DomainEntity

 

GET /account/ipblacklist

Retrieve the list of ip from blacklist.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: Array of

IPEntity {

ip (string): An ip,

hash (string): An hash for this element (used in GET/DELETE operations) [READ ONLY]

 

}

Filters:

  • offset [optional] [string, 0] : Where to start when retrieving domains

  • limit [optional] [integer, 20] : Maximum elements to retrieve

 

POST /account/ipblacklist

Add a new ip in the blacklist.

Input: IPEntity

Result: IPEntity or Error

 

GET /account/ipblacklist/{hash}

Retrieve an ip from the blacklist using {hash}.

Result: IPEntity

 

DELETE /account/ipblacklist/{hash}

Remove an ip from blacklist using {hash}.

Result: IPEntity

 

For more info read this FAQ: 

Have more questions? Submit a request

0 Comments

Article is closed for comments.