GET checks/command-v2/categories
Gets a list of all command check (version 2) categories that are available for you as customer.
Request example
curl --request GET "https://api-asm1.apica.io/v3/checks/command-v2/categories?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"
Response body model example and description
[ { "id": 2, "name": "Api Tools", "templates": [ { "id": 3, "name": "A & PTR record", "description": "Perform a traceroute and verify output", "arguments": [ { "id": 3, "name": "File path", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "string", "ui_type": "selectlist", "validate": null, "default_value": "100", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 2, "name": "Max hops", "description": "Fully Qualified Domain Name.", "required": true, "definition": { "type": "int", "ui_type": "textbox", "validate": null, "default_value": "0", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } } ], "unit": "byte" }, { "id": 3, "name": "Domain delegation", "description": "DNS A & PTR record (IPv4)", "arguments": [ { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } }, { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } }, { "id": 2, "name": "Max hops", "description": "Fully Qualified Domain Name.", "required": true, "definition": { "type": "int", "ui_type": "textbox", "validate": null, "default_value": "0", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } } ], "unit": "byte" }, { "id": 2, "name": "Traceroute", "description": "Perform a traceroute and verify output", "arguments": [ { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } }, { "id": 3, "name": "File path", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "string", "ui_type": "selectlist", "validate": null, "default_value": "100", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 2, "name": "Max hops", "description": "Fully Qualified Domain Name.", "required": true, "definition": { "type": "int", "ui_type": "textbox", "validate": null, "default_value": "0", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } } ], "unit": "byte" } ] }, { "id": 1, "name": "DNS", "templates": [ { "id": 3, "name": "A & PTR record", "description": "Perform a traceroute and verify output", "arguments": [ { "id": 3, "name": "File path", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "string", "ui_type": "selectlist", "validate": null, "default_value": "100", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 2, "name": "Max hops", "description": "Fully Qualified Domain Name.", "required": true, "definition": { "type": "int", "ui_type": "textbox", "validate": null, "default_value": "0", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } } ], "unit": "byte" }, { "id": 2, "name": "Traceroute", "description": "Perform a traceroute and verify output", "arguments": [ { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } }, { "id": 3, "name": "File path", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "string", "ui_type": "selectlist", "validate": null, "default_value": "100", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 2, "name": "Max hops", "description": "Fully Qualified Domain Name.", "required": true, "definition": { "type": "int", "ui_type": "textbox", "validate": null, "default_value": "0", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } } ], "unit": "byte" }, { "id": 3, "name": "A & PTR record", "description": "Perform a traceroute and verify output", "arguments": [ { "id": 3, "name": "File path", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "string", "ui_type": "selectlist", "validate": null, "default_value": "100", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 2, "name": "Max hops", "description": "Fully Qualified Domain Name.", "required": true, "definition": { "type": "int", "ui_type": "textbox", "validate": null, "default_value": "0", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } } ], "unit": "byte" } ] }, { "id": 3, "name": "Api Tools", "templates": [ { "id": 2, "name": "Traceroute", "description": "Perform a traceroute and verify output", "arguments": [ { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } }, { "id": 3, "name": "File path", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "string", "ui_type": "selectlist", "validate": null, "default_value": "100", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 2, "name": "Max hops", "description": "Fully Qualified Domain Name.", "required": true, "definition": { "type": "int", "ui_type": "textbox", "validate": null, "default_value": "0", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } } ], "unit": "byte" }, { "id": 3, "name": "A & PTR record", "description": "Perform a traceroute and verify output", "arguments": [ { "id": 3, "name": "File path", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "string", "ui_type": "selectlist", "validate": null, "default_value": "100", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 2, "name": "Max hops", "description": "Fully Qualified Domain Name.", "required": true, "definition": { "type": "int", "ui_type": "textbox", "validate": null, "default_value": "0", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } }, { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } } ], "unit": "byte" }, { "id": 3, "name": "Domain delegation", "description": "DNS A & PTR record (IPv4)", "arguments": [ { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } }, { "id": 1, "name": "Domain name", "description": "Specifies the maximum number of hops (max time-to-live value) traceroute will probe.", "required": true, "definition": { "type": "int", "ui_type": "selectlist", "validate": null, "default_value": "1", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Enter valid country code.", "group_label": "" } }, { "id": 2, "name": "Max hops", "description": "Fully Qualified Domain Name.", "required": true, "definition": { "type": "int", "ui_type": "textbox", "validate": null, "default_value": "0", "values": [ "ipv4", "ipv6" ], "max_length": 128, "reg_ex": "^\\w+$", "reg_ex_message": "Host name is not valid.", "group_label": "" } } ], "unit": "byte" } ] } ]
Name | Type | Description |
---|---|---|
id | Integer |
The category's numeric identifier. |
name | String |
The category's name. |
templates | Array |
Category templates. |
id | Integer |
The template's numeric identifier. |
name | String |
The template's name. |
description | String |
The template's description. |
arguments | Array |
The template's arguments. |
id | Integer |
The argument's numeric identifier. |
name | String |
The argument's name. |
description | String |
The argument's description. |
required | Boolean |
Required argument. |
definition | Object |
The argument's definition. |
type | String |
The argument's type. |
ui_type | String |
The argument's UI type. |
validate | String |
The argument's validate rule. |
default_value | String |
The argument's default value. |
values | Array |
The argument's available values list. |
max_length | Integer |
The argument's value max length. |
reg_ex | String |
The argument's value regex rule. |
reg_ex_message | String |
The argument's value regex rule message. |
group_label | String |
The argument's group label for grouping arguments. |
unit | String |
The unit of measure for the check result. |