Group Bot

This section groups opt_pipeline Bots handling.

IsIPAddressBadBot [/presentation-api/v1/is-bad-bot/{ip}/]

IsIPAddressBadBot [GET]

Checks if the ip address was already registered in our database as a bad bot. An example of a request using curl:

curl -X GET https://accelerator.shimmercat.com/presentation-api/v1/is-bad-bot/127.0.0.1/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json'

IsIPAddressRangeBadBot [/presentation-api/v1/is-bad-bot/{iprange}/]

IsIPAddressRangeBadBot [GET]

Checks if the ip address range was already registered in our database as a bad bot. An example of a request using curl:

curl -X GET https://accelerator.shimmercat.com/presentation-api/v1/is-bad-bot/69.208.0.0_31/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json'

ListCustomerBadBotsView [/presentation-api/v1/list-bad-bots/]

ListCustomerBadBotsView [GET]

Get the list of bad bots reported by the customer. An example of a request using curl:

curl -X GET https://accelerator.shimmercat.com/presentation-api/v1/list-bad-bots/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json'

MarkIpAsBadBotView [/presentation-api/v1/mark-as-bad-bot/{ip}/]

MarkIpAsBadBotView [POST]

Mark the ip address as bad bot. You need to specify a domain which you want to add this bot to, and the bot name you will attach that ip address to. If a bot with that name does not exist for one of your domains we will add a new one with the specified name. An example using curl about how to request that endpoint to block the ip address 127.1.1.1:

curl -X POST https://accelerator.shimmercat.com/presentation-api/v1/mark-as-bad-bot/127.1.1.1/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json' -d '{"attach_to_bot": "test", "attach_to_domain": "www.shimmercat.tests.com"}'

MarkIpRangeAsBadBotView [/presentation-api/v1/mark-as-bad-bot/{iprange}/]

MarkIpRangeAsBadBotView [POST]

Mark the ip address range as bad bot. You need to specify a domain which you want to add this bot to, and the bot name you will attach that ip address range to. If a bot with that name does not exist for one of your domains we will add a new one with the specified name. An example using curl about how to request that endpoint to block all the ip address on the range 69.208.0.0/31:

curl -X POST https://accelerator.shimmercat.com/presentation-api/v1/mark-as-bad-bot/69.208.0.0_31/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json' -d '{"attach_to_bot": "test", "attach_to_domain": "www.shimmercat.tests.com"}'

Please notice that we use _ instead of / when sending the ip range on the URL.

RemoveIpFromBadBotListView [/presentation-api/v1/remove-ip-from-bad-bot-list/{ip}/]

RemoveIpFromBadBotListView [POST]

Remove the ip address from the bad bots list. You need to specify a domain from which you want to remove this bot from, and the bot name you will remove that ip address from. An example using curl about how to request that endpoint to remove the ip address 127.1.1.1 from the black list:

curl -X POST https://accelerator.shimmercat.com/presentation-api/v1/remove-ip-from-bad-bot-list/127.1.1.1/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json' -d '{"remove_from_bot": "test", "remove_from_domain": "www.shimmercat.tests.com"}'

RemoveIpRangeFromBadBotListView [/presentation-api/v1/remove-ip-from-bad-bot-list/{iprange}/]

RemoveIpRangeFromBadBotListView [POST]

Remove the ip address range from the bad bots list. You need to specify a domain from which you want to remove this bot from, and the bot name you will remove that ip address range from. An example using curl about how to request that endpoint to remove the ip address range 69.208.0.0/31:

curl -X POST https://accelerator.shimmercat.com/presentation-api/v1/remove-ip-from-bad-bot-list/69.208.0.0_31/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json' -d '{"remove_from_bot": "test", "remove_from_domain": "www.shimmercat.tests.com"}'

Please notice that we use _ instead of / when sending the ip range on the URL.

IsIPAddressVIPBot [/presentation-api/v1/is-vip-bot/{ip}/]

IsIPAddressVIPBot [GET]

Checks if the ip address was already registered in our database as a VIP bot. An example of a request using curl:

curl -X GET https://accelerator.shimmercat.com/presentation-api/v1/is-vip-bot/127.0.1.1/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json'

IsIPAddressRangeVIPBot [/presentation-api/v1/is-vip-bot/{iprange}/]

IsIPAddressRangeVIPBot [GET]

Checks if the ip address range was already registered in our database as a VIP bot. An example of a request using curl:

curl -X GET https://accelerator.shimmercat.com/presentation-api/v1/is-vip-bot/69.209.0.0_31/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json'

ListCustomerVIPBotsView [/presentation-api/v1/list-vip-bots/]

ListCustomerVIPBotsView [GET]

Get the list of VIP bots reported by the customer. An example of a request using curl:

curl -X GET https://accelerator.shimmercat.com/presentation-api/v1/list-vip-bots/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json'

MarkIpAsVIPBotView [/presentation-api/v1/mark-as-vip-bot/{ip}/]

MarkIpAsVIPBotView [POST]

Mark the ip address as VIP bot. You need to specify a domain which you want to add this bot to, and the bot name you will attach that ip address to. If a bot with that name does not exist for one of your domains we will add a new one with the specified name. An example using curl about how to request that endpoint to white-list the ip address 127.1.2.1:

curl -X POST https://accelerator.shimmercat.com/presentation-api/v1/mark-as-vip-bot/127.1.2.1/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json' -d '{"attach_to_bot": "test", "attach_to_domain": "www.shimmercat.tests.com"}'

MarkIpRangeAsVIPBotView [/presentation-api/v1/mark-as-vip-bot/{iprange}/]

MarkIpRangeAsVIPBotView [POST]

Mark the ip address range as VIP bot. You need to specify a domain which you want to add this bot to, and the bot name you will attach that ip address range to. If a bot with that name does not exist for one of your domains we will add a new one with the specified name. An example using curl about how to request that endpoint to white-list all the ip address on the range 69.209.0.0/31:

curl -X POST https://accelerator.shimmercat.com/presentation-api/v1/mark-as-vip-bot/69.209.0.0_31/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json' -d '{"attach_to_bot": "test", "attach_to_domain": "www.shimmercat.tests.com"}'

Please notice that we use _ instead of / when sending the ip range on the URL.

RemoveIpFromVIPBotListView [/presentation-api/v1/remove-ip-from-vip-bot-list/{ip}/]

RemoveIpFromVIPBotListView [POST]

Remove the ip address from the VIP bots list. You need to specify a domain from which you want to remove this bot from, and the bot name you will remove that ip address from. An example using curl about how to request that endpoint to remove the ip address 127.1.2.1 from the white list:

curl -X POST https://accelerator.shimmercat.com/presentation-api/v1/remove-ip-from-vip-bot-list/127.1.2.1/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json' -d '{"remove_from_bot": "test", "remove_from_domain": "www.shimmercat.tests.com"}'

RemoveIpRangeFromVIPBotListView [/presentation-api/v1/remove-ip-from-vip-bot-list/{iprange}/]

RemoveIpRangeFromVIPBotListView [POST]

Remove the ip address range from the VIP bots list. You need to specify a domain from which you want to remove this bot from, and the bot name you will remove that ip address range from. An example using curl about how to request that endpoint to remove the ip address range 69.209.0.0/31:

curl -X POST https://accelerator.shimmercat.com/presentation-api/v1/remove-ip-from-vip-bot-list/69.209.0.0_31/ -H 'Authorization: Token <your_authentication_token>' -H 'Content-type: application/json' -d '{"remove_from_bot": "test", "remove_from_domain": "www.shimmercat.tests.com"}'

Please notice that we use _ instead of / when sending the ip range on the URL.