Retrieve asset collection

get

https://sentinel.whitehatsec.com/api/asset

This operation returns an object containing information about all assets to which the current user has access.

NOTE: All display parameters for sites and applications may also be used. See Site and Application APIs for details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

query_asset_type

string

enum

Retrieve assets of a specific type. If omitted, the request will retrieve assets of all types.

Allowed:

query_label_like

string

Retrieve assets that have a label containing the given text.

query_client_id

string

Retrieve assets that have the given client ID.

query_group_id

string

Retrieve assets associated to a particular group as specified by the group's ID.

query_group_name

string

Retrieve assets associated to a particular group as specified by the group's name.

query_has_schedule

string

enum

Defaults to 0

When set to 1, retrieves assets that have an active schedule present. When set to 0, retrieves assets that have no schedule set.

Allowed:

query_schedule_timezone

string

Retrieve assets based on their scan schedule timezone. EXAMPLE: 'America/New_York'

query_schedule_name

string

Retrieve assets based on their schedule name.

query_notags

string

Retrieve assets that do NOT have the specified tags. Accepts a comma-separated list of tags.

query_tags

string

Retrieve assets that have the specified tags. Accepts a comma-separated list of tags.

display_all

string

enum

Defaults to 1

If set to 1, displays all information available for each asset. If set to 0 or omitted, a smaller set of information will be returned.

Allowed:

page:order_by

string

enum

Defaults to id

Order the results.

format

string

enum

Defaults to xml

Format of results.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

500

GenericError generic error.

Language

Loading…

Response

Choose an example:

application/json

application/xml

text/csv, text/comma-separated-values

200Provides the information of asset list.