List targets

GET

/v2/targets

Targets

Last modified:2024-11-12 10:01:42

Get a list of targets

Request

Query Params

page

integer

optional

Page number. Default: 1

per_page

integer

optional

Number of records per page. Default: 10. Max: 100

string

optional

Search by [:name, :uuid, :hosts, :organization_id]. Usage q[column]='word'

date_range_start

string

optional

Start date for date range filter. Format: YYYY-MM-DD hh:mm:ss

date_range_end

string

optional

End date for date range filter. Default: current time. Format: YYYY-MM-DD hh:mm:ss

relative_date_range

string

optional

Relative date range filter.
Available units: (s)econds, (m)inutes, (h)ours, (d)ays, (M)onths, (y)ears. (q)uarter
Example: Get the results for the last 10 days - 10d.
Get the results from the first quarter at 2020 - 1q2020

sort_by

string

optional

Sort by [:creation_time, :modification_time, :name]. Usage: column_name_desc or column_name_asc

limited

boolean

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Targets list

Body

data

array [oneOf]

optional

object (target)

optional

meta

object (meta)

optional

pagination

object (pagination)

optional

filters

object

optional

Example

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "hosts": "string",
      "exclude_hosts": "string",
      "comment": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total_pages": 0,
      "total_count": 0,
      "per_page": 0,
      "current_page": 0,
      "current_page_results": 0
    },
    "filters": {}
  }
}

🟠401Unauthorized

🟠422Parameter Error

Modified at 2024-11-12 10:01:42

Downloads an advanced report file

Create Target