Parameter |
Choices/Defaults |
Comments |
dereference_group_members
boolean
|
|
Indicates whether to dereference "members" field by details level for every object in reply.
|
details_level
string
|
Choices:
- uid
- standard
- full
|
The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.
|
limit
integer
|
|
No more than that many results will be returned. This parameter is relevant only for getting few objects.
|
name
string
|
|
Object name. This parameter is relevant only for getting a specific object.
|
offset
integer
|
|
Skip that many results before beginning to return them. This parameter is relevant only for getting few objects.
|
order
list
/ elements=string
|
|
Sorts results by the given field. By default the results are sorted in the ascending order by name. This parameter is relevant only for getting few objects.
|
|
ASC
string
|
|
Sorts results by the given field in ascending order.
|
|
DESC
string
|
|
Sorts results by the given field in descending order.
|
show_as_ranges
boolean
|
|
When true, the group's matched content is displayed as ranges of IP addresses rather than network objects.<br />Objects that are not represented using IP addresses are presented as objects.<br />The 'members' parameter is omitted from the response and instead the 'ranges' parameter is displayed.
|
show_membership
boolean
|
|
Indicates whether to calculate and show "groups" field for every object in reply.
|
version
string
|
|
Version of checkpoint. If not given one, the latest version taken.
|