Use these HTTP endpoints to upgrade or downgrade Collectors. We recommend you follow our best practices when you upgrade your Collectors.
Mac, iPod, iPhone & iPad Answers. Also see: Recently Added Q&As EveryMac.com answers many of your frequently asked questions about Apple hardware and software. If you are not sure which Mac or device you have, look it up with EveryMac.com's Ultimate Mac Lookup or the EveryMac app.If you need help locating specific identifiers, refer to Mac Identification and iPod, iPhone & iPad Identification. System Requirements Apple Macintosh with OS 10.14 or later. 1.5GHz Intel® Core Duo processor or compatible 1.5GB RAM 2GB available hard-disk space Bluetooth 4.0 macOS 10.14 with the latest service packs or up to macOS 10.14 System Requirements Apple Macintosh with OS 10.14 or older. Sumo Logic is the industry’s leading secure, cloud-native, machine data analytics service, delivering real-time, continuous intelligence across the entire application lifecycle and stack. More than 1,000 customers around the globe rely on Sumo Logic for the analytics and insights to build, run and secure their modern applications and cloud.
The upgrade may automatically be done in increments. In this case, you may experience longer upgrade times.
There is a community-supported script available on GitHub that allows you to conduct bulk actions to Collectors, see Collector Management Script.Timeout
If an upgrade task does not complete successfully after 30 minutes it will automatically timeout with a status of failed.
Get upgradable Collectors
Sends a request to get Collectors you can upgrade.
Method: GET
Path:collectors/upgrades/collectors
Request Headers
| Key | Value |
| Content-Type | application/json |
| Accept | application/json |
Query Parameters
| Parameter | Type | Required | Default | Description |
| toVersion | String | No | Latest Version | Collector build to upgrade (or downgrade) to. If not specified, upgrades to the latest version. |
| offset | Int | No | 0 | Offset into the list of Collectors. |
| limit | Int | No | 50 | Maximum number of Collectors to return. |
Status Code
| Code | Text | Description |
| 200 | OK | Upgradable Collectors were retrieved and provided in the response payload. |
| 415 | Unsupported Media Type | Content-Type wasn't set to application/json. |
| 400 | Bad Request | A parameter wasn't valid. |
Success Result
A JSON document containing the upgradable collectors.
Sample Session
Sample request:
Sample response:
Get available builds
Method: GET
Path: /collectors/upgrades/targets
Request Headers
| Key | Value |
| Content-Type | application/json |
| Accept | application/json |
Tots' Sumo Mac Os Catalina
Query Parameters
None
Status Code
| Code | Text | Description |
| 200 | OK | The build information has been returned in the response payload. |
| 415 | Unsupported Media Type | Content-Type wasn't set to application/json. |
Success Result
A JSON document containing the versions of collector builds, which includes the following fields
| Field | Description |
| version | (string) Version of the collector build. |
| latest | (boolean) Whether it's the latest version. |
Sample Session
Sample request:
Sample response:
Create an upgrade or downgrade task
Method:POST
Path:/collectors/upgrades
Request Headers
| Key | Value |
| Content-Type | application/json |
| Accept | application/json |
Query Parameters
None
JSON Payload Parameters
| Parameter | Type | Required | Default | Description |
| collectorId | Long | Yes | Identifier of the Collector to upgrade (or downgrade). | |
| toVersion | String | No | Latest version | Collector build to upgrade (or downgrade) to. If not specified, upgrades to the latest version. |
Status Code
| Code | Text | Description |
| 202 | Accepted | The upgrade task has been created successfully. |
| 415 | Unsupported Media Type | Content-Type wasn't set to application/json. |
| 400 | Bad Request | Generic request error by the client. |
Success Result
With success, a JSON document is returned containing the ID and link of the newly created upgrade task. This is an opaque string to use for following upgrade status checking API.
Error Result
A status code 400 will be returned with following error codes.
| Code | Description |
| collector.invalid | The Collector ID was not provided, doesn't exist, or the user doesn't have permission to use it. |
| collector.type.invalid | The Collector is not an Installed Collector (it is a Hosted Collector). |
| collector.not.alive | The Collector is not running. |
| collector.in.upgrading | The Collector is currently being upgraded. |
| collector.version.invalid | The upgrade version was not provided, or the version is not valid. |
Sample Session
Sample request:
Sample response:
Get upgrade task status
After obtaining the upgrade job ID, you can obtain the status of the upgrade task from the status endpoint.
Method: GET
Path: /collectors/upgrades/<upgradeTaskID>
Request Headers
| Key | Value |
| Content-Type | application/json |
| Accept | application/json |
Query Parameters
| Parameter | Type | Required | Description |
| upgradeTaskID | Long | Yes | Task ID from the upgrade task. |
Status Code
| Code | Text | Description |
| 200 | OK | The upgrade task status has been returned in the response. |
| 415 | Unsupported Media Type | Content-Type wasn't set to application/json. |
| 404 | Not found | The upgrade task ID was not found. |
Success Result
A success result generates a JSON document containing the upgrade task status, including the following fields.
| Field | Description |
| collectorId | Collector ID of this upgrade task (long). |
| toVersion | Target version of this upgrade task (string). |
| requestedTime | UNIX timestamp when the upgrade task is requested (long). |
| status | Status code for the upgrade task (integer): 0 - not started 1 - pending, the upgrade is issued awaiting a response from the Collector. 2 - succeeded 3 - failed 6 - Progressing, the upgrade is running on the Collector. |
| message | Any additional message, normally a failed reason (string). |
Sample session
Mac Os Mojave
Sample request:
Tots' Sumo Mac Os X
Sample response: