Search
Overview Installation Concepts Setting up SSL/TLS FAQ Advanced configuration Changelog Varnish Agent About Changelog Api reference Parameters API Reference Introduction Cache (Varnish instance) Group VCL Parameters Ban User Message Snippet VAC related Super Fast Purger Introduction Setup and Security How to use

Message

{
    "list": [
        {
            "action": [
                "NODE",
                "GROUP",
                "NODE_CONSISTENCY"
            ],
            "created": "2017-10-17T10:24+0200",
            "extra": {
                "data": {
                    "failed_params": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "node_id": "5989c787436cde7136986b3e",
                    "node_name": "127.0.0.1:17085_c1",
                    "param_consistency": true,
                    "service_status": true,
                    "vcl_consistency": false,
                    "vcl_name": "demo_20171016_114409_59e47f6",
                    "vcl_rectify_failed": "Failed to push vcl to agent. 500 Message from VCC-compiler:\nExpected an action, 'if', '{' or '}'\n('<vcl.inline>' Line 18 Pos 5)\n    elseif (req.http.host ~ \"192.168.50.20\") { set req.backend_hint = two; }\n----######------------------------------------------------------------------\n\nRunning VCC-compiler failed, exited with 2\nVCL compilation failed"
                },
                "info": {
                    "desc": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "group_name": "alfredo",
                    "mainAction": "NODE_CONSISTENCY",
                    "node_id": "5989c787436cde7136986b3e",
                    "node_name": "127.0.0.1:17085_c1",
                    "type": "NODE"
                }
            },
            "id": "59e5be2377c8096ca5e77b99",
            "label": "agent",
            "severity": "NA",
            "timestamp": "2017-10-17T10:24+0200",
            "title": "Node 127.0.0.1:17085_c1 was inconsistent to group alfredo"
        }
    ]
}


GET
Description: Retrieve a single entity.
Expected: HTTP 200
 

{
    "action": [
        "NODE",
        "GROUP",
        "NODE_CONSISTENCY"
    ],
    "created": "2017-10-16T16:28+0200",
    "extra": {
        "data": {
            "failed_params": "",
            "group_id": "59d623cabf085f6187eb9d5f",
            "node_id": "5989c787436cde7136986b3e",
            "node_name": "127.0.0.1:17085_c1",
            "param_consistency": true,
            "service_status": true,
            "vcl_consistency": false,
            "vcl_name": "demo_20171016_114409_59e47f6",
            "vcl_rectify_failed": "Failed to push vcl to agent. 500 Message from VCC-compiler:\nExpected an action, 'if', '{' or '}'\n('<vcl.inline>' Line 18 Pos 5)\n    elseif (req.http.host ~ \"192.168.50.20\") { set req.backend_hint = two; }\n----######------------------------------------------------------------------\n\nRunning VCC-compiler failed, exited with 2\nVCL compilation failed"
        },
        "info": {
            "desc": "",
            "group_id": "59d623cabf085f6187eb9d5f",
            "group_name": "alfredo",
            "mainAction": "NODE_CONSISTENCY",
            "node_id": "5989c787436cde7136986b3e",
            "node_name": "127.0.0.1:17085_c1",
            "type": "NODE"
        }
    },
    "id": "59e4c1f377c8096ca5e778d4",
    "label": "agent",
    "severity": "NA",
    "timestamp": "2017-10-16T16:28+0200",
    "title": "Node 127.0.0.1:17085_c1 was inconsistent to group alfredo"
}


GET
Description: Retrieve a collection of entities; the select * routine.
Expected: HTTP 200

The response below is reduced for clarity

{
    "list": [
        {
            "action": [
                "NODE",
                "GROUP",
                "NODE_CONSISTENCY"
            ],
            "created": "2017-10-16T16:28+0200",
            "extra": {
                "data": {
                    "failed_params": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "node_id": "5989c787436cde7136986b3e",
                    "node_name": "127.0.0.1:17085_c1",
                    "param_consistency": true,
                    "service_status": true,
                    "vcl_consistency": false,
                    "vcl_name": "demo_20171016_114409_59e47f6",
                    "vcl_rectify_failed": "Failed to push vcl to agent. 500 Message from VCC-compiler:\nExpected an action, 'if', '{' or '}'\n('<vcl.inline>' Line 18 Pos 5)\n    elseif (req.http.host ~ \"192.168.50.20\") { set req.backend_hint = two; }\n----######------------------------------------------------------------------\n\nRunning VCC-compiler failed, exited with 2\nVCL compilation failed"
                },
                "info": {
                    "desc": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "group_name": "alfredo",
                    "mainAction": "NODE_CONSISTENCY",
                    "node_id": "5989c787436cde7136986b3e",
                    "node_name": "127.0.0.1:17085_c1",
                    "type": "NODE"
                }
            },
            "id": "59e4c1f377c8096ca5e778d4",
            "label": "agent",
            "severity": "NA",
            "timestamp": "2017-10-16T16:28+0200",
            "title": "Node 127.0.0.1:17085_c1 was inconsistent to group alfredo"
        },
        {
            "action": [
                "NODE",
                "GROUP",
                "NODE_CONSISTENCY"
            ],
            "created": "2017-10-16T16:28+0200",
            "extra": {
                "data": {
                    "failed_params": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "node_id": "5989c77e436cde7136986b3a",
                    "node_name": "192.168.50.103:36085_cache3",
                    "param_consistency": true,
                    "service_status": true,
                    "vcl_consistency": false,
                    "vcl_name": "demo_20171016_114409_59e47f6",
                    "vcl_rectify_failed": "Failed to push vcl to agent. 500 Message from VCC-compiler:\nExpected an action, 'if', '{' or '}'\n('<vcl.inline>' Line 18 Pos 5)\n    elseif (req.http.host ~ \"192.168.50.20\") { set req.backend_hint = two; }\n----######------------------------------------------------------------------\n\nRunning VCC-compiler failed, exited with 2\nVCL compilation failed"
                },
                "info": {
                    "desc": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "group_name": "alfredo",
                    "mainAction": "NODE_CONSISTENCY",
                    "node_id": "5989c77e436cde7136986b3a",
                    "node_name": "192.168.50.103:36085_cache3",
                    "type": "NODE"
                }
            },
            "id": "59e4c1f277c8096ca5e778d3",
            "label": "agent",
            "severity": "NA",
            "timestamp": "2017-10-16T16:28+0200",
            "title": "Node 192.168.50.103:36085_cache3 was inconsistent to group alfredo"
        }
    ]
}


GET
Description: Retrieve a collection of entities based on number of pages and items per page.
Expected: HTTP 200

{page_number} - the page within all the messages you want to display.

{items_per_page} - the number of items within a page The response below is reduced for clarity

{
    "list": [
        {
            "action": [
                "NODE",
                "GROUP",
                "NODE_CONSISTENCY"
            ],
            "created": "2017-10-17T10:04+0200",
            "extra": {
                "data": {
                    "failed_params": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "node_id": "5989c787436cde7136986b3e",
                    "node_name": "127.0.0.1:17085_c1",
                    "param_consistency": true,
                    "service_status": true,
                    "vcl_consistency": false,
                    "vcl_name": "demo_20171016_114409_59e47f6",
                    "vcl_rectify_failed": "Failed to push vcl to agent. 500 Message from VCC-compiler:\nExpected an action, 'if', '{' or '}'\n('<vcl.inline>' Line 18 Pos 5)\n    elseif (req.http.host ~ \"192.168.50.20\") { set req.backend_hint = two; }\n----######------------------------------------------------------------------\n\nRunning VCC-compiler failed, exited with 2\nVCL compilation failed"
                },
                "info": {
                    "desc": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "group_name": "alfredo",
                    "mainAction": "NODE_CONSISTENCY",
                    "node_id": "5989c787436cde7136986b3e",
                    "node_name": "127.0.0.1:17085_c1",
                    "type": "NODE"
                }
            },
            "id": "59e5b97377c8096ca5e77b7a",
            "label": "agent",
            "severity": "NA",
            "timestamp": "2017-10-17T10:04+0200",
            "title": "Node 127.0.0.1:17085_c1 was inconsistent to group alfredo"
        },
        {
            "action": [
                "NODE",
                "GROUP",
                "NODE_CONSISTENCY"
            ],
            "created": "2017-10-17T10:04+0200",
            "extra": {
                "data": {
                    "failed_params": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "node_id": "5989c77e436cde7136986b3a",
                    "node_name": "192.168.50.103:36085_cache3",
                    "param_consistency": true,
                    "service_status": true,
                    "vcl_consistency": false,
                    "vcl_name": "demo_20171016_114409_59e47f6",
                    "vcl_rectify_failed": "Failed to push vcl to agent. 500 Message from VCC-compiler:\nExpected an action, 'if', '{' or '}'\n('<vcl.inline>' Line 18 Pos 5)\n    elseif (req.http.host ~ \"192.168.50.20\") { set req.backend_hint = two; }\n----######------------------------------------------------------------------\n\nRunning VCC-compiler failed, exited with 2\nVCL compilation failed"
                },
                "info": {
                    "desc": "",
                    "group_id": "59d623cabf085f6187eb9d5f",
                    "group_name": "alfredo",
                    "mainAction": "NODE_CONSISTENCY",
                    "node_id": "5989c77e436cde7136986b3a",
                    "node_name": "192.168.50.103:36085_cache3",
                    "type": "NODE"
                }
            },
            "id": "59e5b97277c8096ca5e77b79",
            "label": "agent",
            "severity": "NA",
            "timestamp": "2017-10-17T10:04+0200",
            "title": "Node 192.168.50.103:36085_cache3 was inconsistent to group alfredo"
        }
    ]
}


PUT/PATCH
Description: Update a single entity. Note that PATCH is supported. This means that values are merged and unsupported fields are ignored.
Expected: HTTP 200
Content-Type: application/json

Note that foreign key relations are ignored. Explicit API calls are put in place to support these relationships.

Example of a Payload:

{
"message": {
    "timestamp": 1379252601884,
    "reqMethod": "POST",
    "respCode": 200,
    "reqURI": "/api/rest/login",
    "reqProtocol": "HTTP/1.1"
},
"title": "Test test",
"severity": "NA"
}


DELETE
Description: Remove a single entity.
Expected: HTTP 200
 

{
    "message": "Entity with id=59e5b97377c8096ca5e77b7a removed successfully."
}


Create message

POST
Description: Create a new entity.
Expected: HTTP 200
Content-Type: application/json
 

{
"message": {
    "timestamp": 1379252601884,
    "reqMethod": "POST",
    "respCode": 200,
    "reqURI": "/api/rest/login",
    "reqProtocol": "HTTP/1.1"
},
"title": "Test test",
"severity": "NA"
}


{
    "action": [],
    "created": "2017-10-17T10:23+0200",
    "extra": {
        "data": {},
        "info": {}
    },
    "id": "59e5bdf377c8096ca5e77b96",
    "label": "",
    "message": {
        "reqMethod": "POST",
        "reqProtocol": "HTTP/1.1",
        "reqURI": "/api/rest/login",
        "respCode": 200,
        "timestamp": 1379252601884
    },
    "severity": "NA",
    "timestamp": "2017-10-17T10:23+0200",
    "title": "Test test"
}


Note:

You can change the number of weeks you want to keep messages around in /var/opt/vac/defaults

# message clean up job
msg_to_keep_in_weeks=2
Manuals
Varnish Cache Plus
Varnish Cloud
Varnish Live
Varnish Controller
Varnish High Availability
Varnish Custom Statistics
Varnish WAF
Varnish Broadcaster
News
Varnish Cache Plus 6.0.10r5
Varnish Administration Console - End of Life notice
Container images updated to Debian bullseye
Varnish Cache Plus 6.0.10r4
Varnish HTTP/2 Request Forgery
News archive