Lists agent assets - Gorelo Documentation

GET

assets

agents

Lists agent assets

curl --request GET \
  --url https://api.usw.gorelo.io/v1/assets/agents \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.usw.gorelo.io/v1/assets/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/assets/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/assets/agents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/assets/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Name": "<string>",
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "ClientId": 123,
      "LocationId": 123,
      "ContactId": 7962,
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z",
      "DisplayName": "<string>",
      "Description": "<string>",
      "Banner": "<string>",
      "TimeZone": "<string>",
      "LastBootUpTime": "2023-11-07T05:31:56Z",
      "LastDisconnectDateTime": "2023-11-07T05:31:56Z",
      "LastLoggedOnUser": "<string>",
      "LastLoggedOnUserUpn": "<string>",
      "LastLoggedOnUserDatetime": "2023-11-07T05:31:56Z",
      "Os": "<string>",
      "OsType": "<string>",
      "OsName": "<string>",
      "OsVersion": "<string>",
      "OsArchitecture": "<string>",
      "HardwareArchitecture": "<string>",
      "Type": {
        "Id": 1,
        "Name": "<string>"
      },
      "HardwareType": "<string>",
      "Manufacturer": "<string>",
      "Model": "<string>",
      "SerialNumber": "<string>",
      "SerialNo": "<string>",
      "WarrantyStartDate": "2023-11-07T05:31:56Z",
      "WarrantyEndDate": "2023-11-07T05:31:56Z",
      "Cpu": "<string>",
      "Memory": "<string>",
      "Disk": "<string>",
      "LocalIPAddress": "<string>",
      "PublicIPAddress": "<string>",
      "Uuid": "<string>",
      "ShellVersion": "<string>",
      "RmmVersion": "<string>",
      "InstallerVersion": "<string>",
      "SecurityPosture": {
        "Antivirus": {
          "Id": 1,
          "Name": "Up To Date",
          "Passing": true
        },
        "Firewall": {
          "Id": 1,
          "Name": "Up To Date",
          "Passing": true
        },
        "Patches": {
          "Id": 1,
          "Name": "Up To Date",
          "Passing": true
        },
        "Apps": {
          "Id": 1,
          "Name": "Up To Date",
          "Passing": true
        }
      }
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Query Parameters

Cursor

string

Opaque pagination cursor from a previous page; omit for the first page.

PageSize

integer<int32>

default:50

Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped.

StatusIds

string

Comma-separated device status ids to include: 1 Unreachable, 2 Online, 3 Offline, 4 Pending Delete, 6 Pending client inactive. Up to 100 ids; any other value is a 400. Deleted and client-inactivated devices are excluded either way.

ClientIds

string

Comma-separated client ids to include. Omit for every client.

Query

string

Keyword matched against the device name, display name and description. Up to 200 characters.

UpdatedSince

string<date-time>

ISO-8601 timestamp; keeps only devices updated at or after it.

UpdatedBefore

string<date-time>

ISO-8601 timestamp; keeps only devices updated strictly before it.

CreatedSince

string<date-time>

ISO-8601 timestamp; keeps only devices created at or after it.

CreatedBefore

string<date-time>

ISO-8601 timestamp; keeps only devices created strictly before it.

Response

StatusCode

enum<integer>

Available options:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object[] | null

Show child attributes

DataContext

object

The DataContext of a cursor-paginated success response: carries the paging metadata for the returned page.

Show child attributes

Notifications

object[]

Show child attributes

⌘I

Lists agent assets

curl --request GET \
  --url https://api.usw.gorelo.io/v1/assets/agents \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.usw.gorelo.io/v1/assets/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/assets/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/assets/agents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/assets/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Name": "<string>",
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "ClientId": 123,
      "LocationId": 123,
      "ContactId": 7962,
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z",
      "DisplayName": "<string>",
      "Description": "<string>",
      "Banner": "<string>",
      "TimeZone": "<string>",
      "LastBootUpTime": "2023-11-07T05:31:56Z",
      "LastDisconnectDateTime": "2023-11-07T05:31:56Z",
      "LastLoggedOnUser": "<string>",
      "LastLoggedOnUserUpn": "<string>",
      "LastLoggedOnUserDatetime": "2023-11-07T05:31:56Z",
      "Os": "<string>",
      "OsType": "<string>",
      "OsName": "<string>",
      "OsVersion": "<string>",
      "OsArchitecture": "<string>",
      "HardwareArchitecture": "<string>",
      "Type": {
        "Id": 1,
        "Name": "<string>"
      },
      "HardwareType": "<string>",
      "Manufacturer": "<string>",
      "Model": "<string>",
      "SerialNumber": "<string>",
      "SerialNo": "<string>",
      "WarrantyStartDate": "2023-11-07T05:31:56Z",
      "WarrantyEndDate": "2023-11-07T05:31:56Z",
      "Cpu": "<string>",
      "Memory": "<string>",
      "Disk": "<string>",
      "LocalIPAddress": "<string>",
      "PublicIPAddress": "<string>",
      "Uuid": "<string>",
      "ShellVersion": "<string>",
      "RmmVersion": "<string>",
      "InstallerVersion": "<string>",
      "SecurityPosture": {
        "Antivirus": {
          "Id": 1,
          "Name": "Up To Date",
          "Passing": true
        },
        "Firewall": {
          "Id": 1,
          "Name": "Up To Date",
          "Passing": true
        },
        "Patches": {
          "Id": 1,
          "Name": "Up To Date",
          "Passing": true
        },
        "Apps": {
          "Id": 1,
          "Name": "Up To Date",
          "Passing": true
        }
      }
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}