Collector Management APIs

The Collector Management API gives you the ability to manage Collectors and Sources from HTTP endpoints. See the topics below for Collector API and Source API methods and examples, as well as upgrading and downgrading Collectors using the API.

warning

Collector Management APIs are not yet built with OpenAPI specifications and therefore not included in our Swagger docs. Instead, refer to the below documentation.

Installed Collector and Hosted Collector

Collector Management APIs for Installed and Hosted collectors are not yet built with OpenAPI specifications and therefore not included in our Swagger docs. Instead, refer to the documentation in this section.

OpenTelemetry Collector

This API manages your OpenTelemetry collectors.

Documentation

To get started with Sumo Logic APIs, see API Authentication, Endpoints, and Security.

Our APIs are built with OpenAPI. You can generate client libraries in several languages and explore automated testing.

To access our API documentation, navigate to the appropriate link based on your Sumo deployment. Deployment types differ based on geographic location and account creation date. If unsure, see Which endpoint should I use?

Deployment	Documentation URL
AU	https://api.au.sumologic.com/docs/#tag/otCollectorManagementExternal
CA	https://api.ca.sumologic.com/docs/#tag/otCollectorManagementExternal
DE	https://api.de.sumologic.com/docs/#tag/otCollectorManagementExternal
EU	https://api.eu.sumologic.com/docs/#tag/otCollectorManagementExternal
FED	https://api.fed.sumologic.com/docs/#tag/otCollectorManagementExternal
IN	https://api.in.sumologic.com/docs/#tag/otCollectorManagementExternal
JP	https://api.jp.sumologic.com/docs/#tag/otCollectorManagementExternal
KR	https://api.kr.sumologic.com/docs/#tag/otCollectorManagementExternal
US1	https://api.sumologic.com/docs/#tag/otCollectorManagementExternal
US2	https://api.us2.sumologic.com/docs/#tag/otCollectorManagementExternal

Guide contents

In this section, we'll introduce the following concepts:

📄️ Collector API Methods and Examples

The Collector Management API gives you the ability to manage Collectors and Sources from HTTP endpoints.

📄️ Source API Methods and Examples

Source API methods allow you to create installed or hosted Sources of any type by specifying the sourceType parameter.

📄️ Upgrade or Downgrade Collectors

View and manage the software versions of your Installed Collectors through HTTP endpoints. Use these HTTP endpoints to upgrade or downgrade Collectors. We recommend you follow our best practices when you upgrade your Collectors.