These parameters are valid for use with these ticket APIs - ticket_list.php, ticket_edit.php, ticket_delete.php.
Parameter |
Required/ Optional |
Data Type |
Description |
---|---|---|---|
Ticket Number |
|
||
ticket_numbers={nnn,nnn-nnn,...} |
Required |
Integer |
Tickets with certain ticket numbers. Specify one or more ticket numbers and/or ranges. Use a dash (-) to separate the ticket range start and end. Multiple entries are comma separated. |
since_ticket_number={value} |
Optional |
Integer |
Tickets since a certain ticket number. Specify the lowest ticket number to be selected. Selected tickets will have numbers greater than or equal to the ticket number specified. |
until_ticket_number={value} |
Optional |
Integer |
Tickets until a certain ticket number. Specify the highest ticket number to be selected. Selected tickets will have numbers less than or equal to the ticket number specified. |
These parameters are valid with all ticket functions except List Deleted Tickets.
Parameter |
Required/ Optional |
Data Type |
Description |
---|---|---|---|
Ticket Properties |
|
||
ticket_assignee={value} |
Required |
String |
Tickets with a certain assignee. Specify the user login of an active user account. |
overdue={0|1} |
Optional |
Integer |
Tickets that are overdue or not overdue. When not specified, overdue and non-overdue tickets are selected. Specify 1 to select only overdue tickets. Specify 0 to select only tickets that are not overdue. |
invalid={0|1} |
Optional |
Integer |
Tickets that are invalid or valid. When not specified, both valid and invalid tickets are selected. Specify 1 to select only invalid tickets. Specify 0 to select only valid tickets. You can select invalid tickets owned by other users, not yourself. |
states={value} |
Optional |
Boolean |
Tickets with certain ticket state/status. Specify one or more state/status codes. Multiple entries are comma separated. Valid values: OPEN = Open or Open/Reopened RESOLVED = Resolved CLOSED = Closed/Fixed IGNORED = Closed/Ignored To select ignored vulnerabilities on hosts, specify states=IGNORED. |
Ticket History |
|
|
|
modified_since_datetime={value} |
Optional |
Integer |
Tickets modified since a certain date/time. Specify a date (required) and time (optional) since tickets were modified. Tickets modified on or after the date/time are selected. The start date/time is specified in YYYY-MM-DD[THH:MM:SSZ] format (UTC/GMT), like “2006-01-01” or “2006-05-25T23:12:00Z”. |
unmodified_since_datetime={value} |
Optional |
Integer |
Tickets not modified since a certain date/time. Specify a date (required) and time (optional) since tickets were not modified. Tickets not modified on or after the date/time are selected. The date/time is specified in YYYY-MM-DD[THH:MM:SSZ] format (UTC/GMT), like “2006-01-01” or “2006-05-25T23:12:00Z”. |
Ticket Host Information |
|
|
|
ips={nnn,nnn-nnn,...} |
Optional |
Integer |
Tickets on hosts with certain IP addresses. Specify one or more IP addresses and/or ranges. Multiple entries are comma separated. |
asset_groups={ag1,ag2,...} |
Optional |
Integer |
Tickets on hosts with IP addresses which are defined in certain asset groups. Specify the title of one or more asset groups. Multiple asset groups are comma separated. The title “All” may be specified to select all IP addresses in the user account. |
dns_contains={value} |
Optional |
Integer |
Tickets on hosts that have a NetBIOS host name which contains a certain text string. Specify a text string to be used. This string may include a maximum of 100 characters (ascii). |
netbios_contains={value} |
Optional |
Integer |
Tickets on hosts that have a NetBIOS host name which contains a certain text string. Specify a text string to be used. This string may include a maximum of 100 characters (ascii). |
host_id={value} |
Optional |
Integer |
Tickets related to a particular asset when the specific HOST_ID is provided. |
show_host_id={0|1} |
Optional |
Integer |
When unspecified or show_host_id=0, the Host ID will not appear in the XML output. Specify show_host_id=1 to show the Host ID in the output. |
Ticket Vulnerability Information |
|
|
|
vuln_severities={1,2,3,4,5} |
Optional |
Integer |
Tickets for vulnerabilities with certain severity levels. Specify one or more severity levels. Multiple levels are comma separated. |
potential_vuln_severities={1,2,3,4,5} |
Optional |
Integer |
Tickets for potential vulnerabilities with certain severity levels. Specify one or more severity levels. Multiple levels are comma separated. |
qids={qid,qid,...} |
Optional |
Integer |
Tickets for vulnerabilities with certain QIDs (Qualys IDs). Specify one or more QIDs. A maximum of 10 QIDs may be specified. Multiple QIDs are comma separated. |
vuln_title_contains={value} |
Optional |
String |
Tickets for vulnerabilities that have a title which contains a certain text string. The vulnerability title is defined in the KnowledgeBase. Specify a text string. This string may include a maximum of 100 characters (ascii). |
vuln_details_contains={value} |
Optional |
String |
Tickets for vulnerabilities that have vulnerability details which contain a certain text string. Vulnerability details provide descriptions for threat, impact, solution and results (scan test results, when available). Specify a text string. This string may include a maximum of 100 characters (ascii). |
vendor_ref_contains={value} |
Optional |
String |
Tickets for vulnerabilities that have a vendor reference which contains a certain text string. Specify a text string. This string may include a maximum of 100 characters (ascii). |