Ban

Ban Object

{
    "list": [
        {
            "_id": {
                "$oid": "59d63155bf085f6187eb9ecf"
            },
            "created": {
                "$date": "2017-10-05T13:19:17.865Z"
            },
            "expression": "req.url ~ /",
            "target": {
                "$id": {
                    "$oid": "59d623cabf085f6187eb9d5f"
                },
                "$ref": "vcc_group"
            },
            "timestamp": {
                "$date": "2017-10-05T13:19:17.971Z"
            },
            "user": {
                "$id": {
                    "$oid": "521afbcdd29aeea08603b01c"
                },
                "$ref": "vcc_user"
            }
        }
    ]
}

Issue ban to group

POST

Description: Issuing ban to a group that contains caches will tell the vac to relay these ban expressions directly to said caches

Expected: HTTP 200

Content-Type: application/json

Payload Response

Verify the bans via varnishadm or run varnish-agent in foreground to see the requests coming through.

{"expression":"req.http.host ~ example.com"}

{
    "bans": {
        "5989c76d436cde7136986b36": {
            "mainAction": "BAN_ISSUED_SUCCESS",
            "response": "",
            "status": 200,
            "title": "Ban issued on 192.168.50.104:46085_cache4 with result OK by vac"
        },
        "5989c77e436cde7136986b3a": {
            "mainAction": "BAN_ISSUED_SUCCESS",
            "response": "",
            "status": 200,
            "title": "Ban issued on 192.168.50.103:36085_cache3 with result OK by vac"
        },
        "5989c787436cde7136986b3e": {
            "mainAction": "BAN_ISSUED_FAILED",
            "response": "Unknown request in manager process (child not running).\nType 'help' for more info.",
            "status": 400,
            "title": "Ban issued on 127.0.0.1:17085_c1 with result NOK by vac"
        }
    },
    "message": "Ban command executed. Notice there are issues with at least one of your nodes. ",
    "title": "Issuing bans on group alfredo by user vac. "
}

Retrieving recent bans in group

GET

Description: Retrieving a JSONArray of recent bans based on pagination. Select * from ban table is forbidden.

Expected: HTTP 200

Response

Example with /api/v1/group/{group_id}/ban/1/2

{page_number}=1 {items_per_page}=2

{
    "list": [
        {
            "_id": {
                "$oid": "59e5cbcd77c8096ca5e77bf4"
            },
            "created": {
                "$date": "2017-10-17T09:22:21.359Z"
            },
            "expression": "req.http.host ~ example.com",
            "target": {
                "$id": {
                    "$oid": "59d623cabf085f6187eb9d5f"
                },
                "$ref": "vcc_group"
            },
            "timestamp": {
                "$date": "2017-10-17T09:22:21.647Z"
            },
            "user": {
                "$id": {
                    "$oid": "521afbcdd29aeea08603b01c"
                },
                "$ref": "vcc_user"
            }
        },
        {
            "_id": {
                "$oid": "59d63155bf085f6187eb9ecf"
            },
            "created": {
                "$date": "2017-10-05T13:19:17.865Z"
            },
            "expression": "req.url ~ /",
            "target": {
                "$id": {
                    "$oid": "59d623cabf085f6187eb9d5f"
                },
                "$ref": "vcc_group"
            },
            "timestamp": {
                "$date": "2017-10-05T13:19:17.971Z"
            },
            "user": {
                "$id": {
                    "$oid": "521afbcdd29aeea08603b01c"
                },
                "$ref": "vcc_user"
            }
        }
    ]
}