JSON RPC

Module description

Goss - a subsystem that manages server validation

Operations

Delete goss check

Context model: Check

Request data

{
    "context": {
        "op": "global_check_del"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ required ] - Check name

Add goss check

Context model: Check

Request data

{
    "context": {
        "op": "global_check_add"
    },
    "data": {
        "name": "<name>",
        "descr": "<descr>",
        "data": "<data>",
        "hook_data": "<hook_data>",
        "cron": "<cron>",
        "run_code": "<run_code>"
    }
}

Description

name [ required ] - Check name

descr [ ] - Check description

data [ jsonstr ] - Check data

hook_data [ jsonstr ] - Hook data

cron [ ] - CRON schedule

run_code [ ] - Run strategy (default - VIP) ['VIP', 'ALL']

Run check

Context model: Check

Request data

{
    "context": {
        "op": "global_check_run"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ required ] - Check name

List goss check

Context model: Check

Request data

{
    "context": {
        "op": "global_check_list"
    }
}

Show goss check

Context model: Check

Request data

{
    "context": {
        "op": "global_check_show"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ required ] - Check name

Update goss check

Context model: Check

Request data

{
    "context": {
        "op": "global_check_update"
    },
    "data": {
        "name": "<name>",
        "descr": "<descr>",
        "data": "<data>",
        "hook_data": "<hook_data>",
        "cron": "<cron>",
        "run_code": "<run_code>"
    }
}

Description

name [ required ] - Check name

descr [ ] - Check description

data [ jsonstr ] - Check data

hook_data [ jsonstr ] - Hook data

cron [ ] - CRON schedule

run_code [ ] - Run strategy (default - VIP) ['VIP', 'ALL']

List goss events

Context model: Event

Request data

{
    "context": {
        "op": "global_event_list"
    },
    "data": {
        "limit": "<limit>"
    }
}

Description

limit [ int ] - Limit count events

Show event

Context model: Event

Request data

{
    "context": {
        "op": "global_event_show"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Uuid of the event

Models

Event

uuid [ required ] - Uuid of the event

Check

name [ required ] - Check name

descr [ ] - Check description

data [ jsonstr ] - Check data

hook_data [ jsonstr ] - Hook data

cron [ ] - CRON schedule

run_code [ ] - Run strategy (default - VIP) ['VIP', 'ALL']