Retrieve a group

get

https://sentinel.whitehatsec.com/api/v2/group/{client_id}/{group_id}

This operation returns an object containing information about a specified Sentinel group. Identifying a group requires a combination of the Client ID and the Group ID.

Path Params

client_id

int32

required

Client ID.

group_id

int32

required

Group ID.

Query Params

display_sites

string

enum

Defaults to 0

Display sites associated with group id.

Allowed:

display_applications

string

enum

Defaults to 0

Display applications associated with group id.

Allowed:

display_roles

string

enum

Defaults to 0

Display roles associated with group id.

Allowed:

display_vuln_stats

string

enum

Defaults to 0

Display statistics for vulnerabilities found on assets in each group.

Allowed:

display_scan_status

string

enum

Defaults to 0

Displays a list of the scan statuses for the assets in each group.

Allowed:

display_has_asset

string

enum

Defaults to 0

Display the 'has_assets' flag, which indicates if each group contains any assets.

Allowed:

page:limit

int32

Number of pages to retrieve.

page:offset

int32

Begin retrieving pages from this index.

page:order_by

string

enum

Defaults to name

Order results in ascending or descending order by name, id, or description.

format

string

enum

Defaults to xml

Selects the requested response representation format.

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

Response

Choose an example:

application/json

application/xml

200Provides the information of Sentinel groups for the particular group.