Retrieval of IP addresses (v2)
Available from 9.2.12. You use the GET
operation
on the api/sam/v2/detailed_hw_ip_addresses
element to request information related
to IP addresses of computers in your infrastructure.
Permissions
You must have the View Endpoints and View Hardware Inventory permission to use this API.
Resource URL
https://hostname:port/api/sam/v2/detailed_hw_ip_addresses?token=token
Resource information
Operation details | Description |
---|---|
HTTP method | GET |
Request headers |
Negotiates the language of the response. If the header is not specified, the content is returned in the server language. |
Request format | application/json |
Response headers |
Specifies the content type of the response. |
Specifies the language of the response content. If the header is not specified, the content is returned in the server language. |
|
Response payload | IP Addresses element |
Response format | application/json |
Response codes |
|
Schema description
GET api/sam/v2/schemas/detailed_hw_ip_address.json?token=token
Available columns
The list of attributes related to IP addresses on the scanned system. The retrieved addresses are in the IPv4 format, except for the ipv6_address attribute.
The output might contain multiple instances of each attribute from this group.
Property | Description | Type |
---|---|---|
id | Identifier of the record. | Integer |
computer_id | Identifier of the computer as specified in the BigFix Inventory database. | Integer |
updated_at | Date and time when the current information was imported to BigFix Inventory. | String |
address | IP address of the computer. | String |
hostname | Host name of the computer with the given IP. | String |
primary_dns | Primary domain name system (DNS). | String |
permanent_mac_address | Permanent media access control (MAC) address associated with the given IP address. | String |
ipv6_address | IP address in version 6. | String |
Related APIs
Query parameters
Parameter | Description | Required | Value |
---|---|---|---|
columns[] | Specify which columns to retrieve. If you do not specify this parameter, only
default columns are retrieved. Example: Retrieve the computer
ID:
|
String | |
order | Specify how to sort the returned data. The default direction for sorting
columns is ascending. If you want to specify a descending sort, append desc to the
column name. Example: Order by computer ID
descending:
|
String | |
limit | Specify the number of rows to retrieve. If you omit this parameter, all rows
are retrieved. Example: Retrieve 100 records
Note: By default the
limit parameter for this API is set to 100000. |
Numeric | |
offset | Specify the number of rows to skip for retrieving results. You can use it
together with the limit parameter to paginate results. Example: Retrieve 50 records starting
after record 150
|
Numeric | |
token | A unique user authentication identifier. You can retrieve it by using REST API for retrieving authentication token. You can also log in to BigFix Inventory, hover over the User icon , and click Profile. Then, click Show token. | ✓ | Alphanumeric |
criteria | Retrieve records which match specific conditions. The parameter should have the following
structure, written in one line:
For more information about operators, see: Common connectors and operators. Example: retrieve
computers with computer ID greater than
1000.
For columns that use the date and time values, you can retrieve data also for a period instead of a specific date. To do so, use last or next as <operator>, and then specify the time value in the following convention: PxD/PxW/PxM/PxY, where x is a number in the 1-999 range, and D, W, M, or Y is a designator that represents days, weeks, months, or years respectively. |
String |
Example conversation - default columns
- Request
-
GET /api/sam/v2/detailed_hw_ip_addresses?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 Host: localhost:9081 Accept: application/json Accept-Language: en-US
- Response body
-
[{ "id":1 "computer_id":1, "updated_at":"2018-05-16T14:37:08Z", "address":"9.174.39.183", "hostname":"NC9174039183", "primary_dns":"9.20.136.11", "permanent_mac_address":"00:50:56:94:7C:95", "ipv6_address":"fe80:0000:0000:0000:44a3:f150:0968:869e%2" }]
Example conversation - selected columns
- Request
-
GET api/sam/v2/detailed_hw_ip_addresses?columns[]=computer_id &columns[]=primary_dns &token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 Host: localhost:9081 Accept: application/json Accept-Language: en-US
- Response body
-
[{ "computer_id":1, "primary_dns":"9.20.136.11"} }]