OT Collector Management API External.
openapi: 3.0.0
info:
title: Sumo Logic accessKeyManagement otCollectorManagementExternal API
description: "# Getting Started\nWelcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on Collector and Search Job APIs, see our [API home page](https://help.sumologic.com/docs/api).\n## API Endpoints\nSumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\n\n <table>\n <tr>\n <td> <strong>Deployment</strong> </td>\n <td> <strong>Endpoint</strong> </td>\n </tr>\n <tr>\n <td> AU </td>\n <td> https://api.au.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> CA </td>\n <td> https://api.ca.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> DE </td>\n <td> https://api.de.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> EU </td>\n <td> https://api.eu.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> FED </td>\n <td> https://api.fed.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> IN </td>\n <td> https://api.in.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> JP </td>\n <td> https://api.jp.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> KR </td>\n <td> https://api.kr.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US1 </td>\n <td> https://api.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US2 </td>\n <td> https://api.us2.sumologic.com/api/ </td>\n </tr>\n </table>\n\n## Authentication\nSumo Logic supports the following options for API authentication:\n- Access ID and Access Key\n- Base64 encoded Access ID and Access Key\n\nSee [Access Keys](https://help.sumologic.com/docs/manage/security/access-keys) to generate an Access Key. Make sure to copy the key you create, because it is displayed only once.\nWhen you have an Access ID and Access Key you can execute requests such as the following:\n ```bash\n curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\nWhere `deployment` is either `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1`, or `us2`. See [API endpoints](#section/API-Endpoints) for details.\n\nIf you prefer to use basic access authentication, you can do a Base64 encoding of your `<accessId>:<accessKey>` to authenticate your HTTPS request. The following is an example request, replace the placeholder `<encoded>` with your encoded Access ID and Access Key string:\n ```bash\n curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\n\nRefer to [API Authentication](https://help.sumologic.com/?cid=3012) for a Base64 example.\n\n## Status Codes\nGeneric status codes that apply to all our APIs. See the [HTTP status code registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) for reference.\n <table>\n <tr>\n <td> <strong>HTTP Status Code</strong> </td>\n <td> <strong>Error Code</strong> </td>\n <td> <strong>Description</strong> </td>\n </tr>\n <tr>\n <td> 301 </td>\n <td> moved </td>\n <td> The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details.</td>\n </tr>\n <tr>\n <td> 401 </td>\n <td> unauthorized </td>\n <td> Credential could not be verified.</td>\n </tr>\n <tr>\n <td> 403 </td>\n <td> forbidden </td>\n <td> This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details.</td>\n </tr>\n <tr>\n <td> 404 </td>\n <td> notfound </td>\n <td> Requested resource could not be found. </td>\n </tr>\n <tr>\n <td> 405 </td>\n <td> method.unsupported </td>\n <td> Unsupported method for URL. </td>\n </tr>\n <tr>\n <td> 415 </td>\n <td> contenttype.invalid </td>\n <td> Invalid content type. </td>\n </tr>\n <tr>\n <td> 429 </td>\n <td> rate.limit.exceeded </td>\n <td> The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. </td>\n </tr>\n <tr>\n <td> 500 </td>\n <td> internal.error </td>\n <td> Internal server error. </td>\n </tr>\n <tr>\n <td> 503 </td>\n <td> service.unavailable </td>\n <td> Service is currently unavailable. </td>\n </tr>\n </table>\n\n## Filtering\nSome API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand `&` character.\n\nExample: To get user with email `john@demo.com`:\n ```bash\n api.sumologic.com/v1/users?email=john@demo.com\n ```\n\n## Sorting\nSome API endpoints support sorting fields by using the `sortBy` query parameter. The default sort order is ascending. Prefix the field with a minus sign `-` to sort in descending order.\n\nFor example, to get 20 users sorted by their `email` in descending order:\n ```bash\n api.sumologic.com/v1/users?limit=20&sort=-email\n ```\n\n## Asynchronous Request\nAsynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.\n1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies\n your asynchronous job.\n\n2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous\n request will typically provide an endpoint to poll for the status of asynchronous job. A successful response\n from the status endpoint will have the following structure:\n ```json\n {\n \"status\": \"Status of asynchronous request\",\n \"statusMessage\": \"Optional message with additional information in case request succeeds\",\n \"error\": \"Error object in case request fails\"\n }\n ```\n The `status` field can have one of the following values:\n 1. `Success`: The job succeeded. The `statusMessage` field might have additional information.\n 2. `InProgress`: The job is still running.\n 3. `Failed`: The job failed. The `error` field in the response will have more information about the failure.\n\n3. Some asynchronous APIs may provide a third endpoint (like [export result](#operation/getAsyncExportResult))\n to fetch the result of an asynchronous job.\n\n\n### Example\nLet's say we want to export a folder with the identifier `0000000006A2E86F`. We will use the [async export](#operation/beginAsyncExport) API to export all the content under the folder with `id=0000000006A2E86F`.\n1. Start an export job for the folder\n ```bash\n curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export\n ```\n See [authentication section](#section/Authentication) for more details about `accessId`, `accessKey`, and\n `deployment`.\n On success, you will get back a job identifier. In the response below, `C03E086C137F38B4` is the job identifier.\n ```bash\n {\n \"id\": \"C03E086C137F38B4\"\n }\n ```\n\n2. Now poll for the status of the asynchronous job with the [status](#operation/getAsyncExportStatus) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status\n ```\n You may get a response like\n ```json\n {\n \"status\": \"InProgress\",\n \"statusMessage\": null,\n \"error\": null\n }\n ```\n It implies the job is still in progress. Keep polling till the status is either `Success` or `Failed`.\n\n3. When the asynchronous job completes (`status != \"InProgress\"`), you can fetch the results with the\n [export result](#operation/getAsyncExportResult) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result\n ```\n\n The asynchronous job may fail (`status == \"Failed\"`). You can look at the `error` field for more details.\n ```json\n {\n \"status\": \"Failed\",\n \"errors\": {\n \"code\": \"content1:too_many_items\",\n \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"\n }\n }\n ```\n\n\n## Rate Limiting\n* A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.\n* A rate limit of 10 concurrent requests to any API endpoint applies to an access key.\n\nIf a rate is exceeded, a rate limit exceeded 429 status code is returned.\n\n## Generating Clients\nYou can use [OpenAPI Generator](https://openapi-generator.tech) to generate clients from the YAML file to access the API.\n\n### Using [NPM](https://www.npmjs.com/get-npm)\n1. Install [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) globally, exposing the CLI\n on the command line:\n ```bash\n npm install @openapitools/openapi-generator-cli -g\n ```\n You can see detailed instructions [here](https://openapi-generator.tech/docs/installation#npm).\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n\n\n### Using [Homebrew](https://brew.sh/)\n1. Install OpenAPI Generator\n ```bash\n brew install openapi-generator\n ```\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client side code inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n"
version: 1.0.0
x-logo:
url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
description: CA deployment API server
- url: https://api.de.sumologic.com/api/
description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
description: KR deployment API server
- url: https://api.in.sumologic.com/api/
description: IN deployment API server
- url: https://api.sumologic.com/api/
description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: otCollectorManagementExternal
description: 'OT Collector Management API External.
'
x-displayName: OpenTelemetry Collector Management
paths:
/v1/otCollectors:
post:
tags:
- otCollectorManagementExternal
summary: Get Paginated List Of OT Collectors
description: Given different filter, search and sort conditions, get list of otCollectors.
operationId: getPaginatedOTCollectors
requestBody:
description: pagination request details
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedOTCollectorsRequest'
required: true
responses:
'200':
description: A list of paginated OT Collectors.
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedOTCollectorsResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/otCollectors/{id}:
get:
tags:
- otCollectorManagementExternal
summary: Get OT Collector By ID.
description: Get OT Collector by ID.
operationId: getOTCollector
parameters:
- name: id
in: path
description: Identifier of the OT Collector to get.
required: true
schema:
type: string
responses:
'200':
description: An OT Collector by identifier.
content:
application/json:
schema:
$ref: '#/components/schemas/OTCollector'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- otCollectorManagementExternal
summary: Delete An OT Collector.
description: Delete an OT Collector with the given identifier.
operationId: deleteOTCollector
parameters:
- name: id
in: path
description: Identifier of the OT Collector to delete.
required: true
schema:
type: string
responses:
'204':
description: The OT Collector was deleted successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/otCollectors/totalCount:
get:
tags:
- otCollectorManagementExternal
summary: Get A Count Of OT Collectors.
description: Get total count of OT Collectors for a customer.
operationId: getOTCollectorsCount
responses:
'200':
description: Total count of OT Collectors.
content:
application/json:
schema:
$ref: '#/components/schemas/OTCollectorCountResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/otCollectors/otCollectorsByName:
get:
tags:
- otCollectorManagementExternal
summary: Get OT Collectors By Name.
description: provided list of names, get all OT Collectors with metadata.
operationId: getOTCollectorsByNames
parameters:
- name: names
in: query
description: A required parameter that accepts a list of names for which we need to collect all metadata.
required: true
schema:
type: array
items:
type: string
responses:
'200':
description: A list of OT Collectors.
content:
application/json:
schema:
$ref: '#/components/schemas/OTCollectorListResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/otCollectors/offline:
delete:
tags:
- otCollectorManagementExternal
summary: Delete All Offline OT Collectors
description: Delete all offline OT Collectors for a given customer.
operationId: deleteOfflineOTCollectors
responses:
'204':
description: All offline OT Collectors of the given customer deleted successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
OTCollectorListResponse:
required:
- data
type: object
properties:
data:
type: array
description: List of OT Collectors.
items:
$ref: '#/components/schemas/OTCollector'
PaginatedOTCollectorsResponse:
required:
- data
type: object
properties:
data:
type: array
description: paginated list of OT Collectors.
items:
$ref: '#/components/schemas/OTCollector'
next:
type: string
description: next page token.
count:
type: integer
description: count of otCollectors in response.
format: int32
VersionRange:
type: object
properties:
minVersion:
pattern: ^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-sumo.+)?$
type: string
description: Minimum version of otCollector.
maxVersion:
pattern: ^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-sumo.+)?$
type: string
description: Maximum version of the collector.
rangeType:
type: string
description: 'Specifies how filtering should be applied when `minVersion` and `maxVersion` are defined. - `Within`: Filtering includes the specified range. - `Outside`: Filtering excludes the specified range. By default, filtering includes the specified range.'
description: Version range for otCollector.
PaginatedOTCollectorsRequest:
type: object
properties:
search:
type: string
description: search by collector id or free text search on collector properties.
example: testAgent
filters:
type: object
properties:
tags:
type: array
description: tags associated with the OT collector
example:
- - key: region
values:
- us2
- mum
- - key: key2
values:
- value2
items:
type: array
items:
$ref: '#/components/schemas/OtTag'
default: []
os:
type: string
description: Name of the Operating System.
nullable: true
example: linux
x-visibility: private
collectorVersionRange:
$ref: '#/components/schemas/VersionRange'
alive:
type: boolean
description: alive Status of the OT Collector based on heartbeat.
nullable: true
example: true
isRemotelyManaged:
type: boolean
description: Management Status of the OT Collector based on if it is remotely or locally managed.
nullable: true
example: true
isUpgradeAvailable:
type: boolean
description: upgrade availability status of the OT Collector.
nullable: true
example: true
hasNoSourceTemplateLinked:
type: boolean
description: whether the remotely managed OT Collector has no source template linked.
nullable: true
example: true
description: parameter which is used for filtering.
sortBy:
type: string
description: parameter which is used for sorting.
example: name
next:
type: string
description: parameter which is used for fetching next set of results.
example: token
limit:
maximum: 1000
minimum: 1
type: integer
description: parameter which is used for limiting number of otCollectors on a page.
format: int32
example: 30
includeCount:
type: boolean
description: count of filtered otCollectors.
nullable: true
example: false
OTCollectorCountResponse:
required:
- totalCount
type: object
properties:
totalCount:
type: integer
description: Total number of OT Collector for a customer.
format: int32
example: 100
description: response for total count of otCollectors.
OTCollector:
required:
- createdAt
- createdBy
- id
- modifiedAt
- modifiedBy
- name
- systemInfo
- version
type: object
properties:
id:
type: string
description: Unique identifier of the OT Collector.
example: 0000000005F5E105
name:
type: string
description: Name of the OT Collector.
example: test OT Collector
version:
required:
- currentVersion
type: object
properties:
currentVersion:
type: string
description: Current version of the OT Collector.
latestAvailableVersion:
type: string
description: Latest available version of the OT Collector.
description: Version information of the OT Collector.
category:
type: string
description: Category of the OT Collector.
example: apache
description:
type: string
description: Description of the OT Collector.
tags:
maxProperties: 1000
type: object
additionalProperties:
type: string
description: Tags associated with the OT Collector.
example:
team: app-dev
showIcon: true
healthIncidentsTracker:
type: object
properties:
errorsCount:
type: integer
description: Number of errors associated with the OT Collector.
format: int32
example: 0
warningsCount:
type: integer
description: Number of warnings associated with the OT Collector.
format: int32
example: 1
description: Health incident information.
ephemeral:
type: boolean
description: Ephemeral Status of the OT Collector.
example: false
alive:
type: boolean
description: Alive Status of the OT Collector based on heartbeat.
example: true
isRemotelyManaged:
type: boolean
description: Management Status of the OT Collector based on if it is remotely or locally managed.
example: true
effectiveConfig:
maxProperties: 1000
type: object
additionalProperties:
type: string
description: Config map that includes Base 64 Encoded Effective Configuration Yaml of the Remotely managed OT Collector.
example:
00000000000000A3: ZGVtbyBjb25maWc=
00000000000000D5: XFVtbfe34tgcvefv=
systemInfo:
type: object
properties:
hostName:
type: string
description: Host name of the OT Collector.
example: app.test.com
hostOsName:
type: string
description: Host OS name of the OT Collector.
example: Linux
hostOsVersion:
type: string
description: Host OS version of the OT Collector.
example: 5.4.144-69.257.amzn2.x86_64
hostIpAddress:
type: string
description: Host IP address of the OT Collector.
example: 19.123.24.66
hostEnv:
type: string
description: Host environment of the OT Collector.
example: EKS-1.20.2
description: System information of the OT Collector.
timeZone:
type: string
description: timezone of the collector
example: UTC
createdAt:
type: string
description: Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
format: date-time
example: 2018-10-16 09:10:00+00:00
createdBy:
type: string
description: Identifier of the user who created the resource.
example: 0000000006A5C7A2
modifiedAt:
type: string
description: Last modification timestamp in UTC.
format: date-time
example: 2018-10-16 09:10:00+00:00
modifiedBy:
type: string
description: Identifier of the user who last modified the resource.
example: 0000000006A5C7A2
sourceTemplateLinkedCount:
type: integer
description: Count of the source templates linked to a collector
example: 1
description: An OT Collector definition.
ErrorDescription:
required:
- code
- message
type: object
properties:
code:
type: string
description: An error code describing the type of error.
example: auth:password_too_short
message:
type: string
description: A short English-language description of the error.
example: Your password was too short.
detail:
type: string
description: An optional fuller English-language description of the error.
example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
meta:
type: object
description: An optional list of metadata about the error.
example:
minLength: 12
actualLength: 5
ErrorResponse:
required:
- errors
- id
type: object
properties:
id:
type: string
description: An identifier for the error; this is unique to the specific API request.
example: IUUQI-DGH5I-TJ045
errors:
type: array
description: A list of one or more causes of the error.
example:
- code: auth:password_too_short
message: Your password was too short.
- code: auth:password_character_classes
message: Your password did not contain any non-alphanumeric characters
items:
$ref: '#/components/schemas/ErrorDescription'
OtTag:
required:
- key
- values
type: object
properties:
key:
type: string
description: key of the given tag.
example: key1
values:
type: array
description: values of the given tag.
items:
type: string
example: value1
securitySchemes:
basicAuth:
type: http
scheme: basic
x-tagGroups:
- name: Archive Management
tags:
- archiveManagement
- name: Health Events
tags:
- healthEvents
- name: Infrequent Data Tier
tags:
- logSearchesEstimatedUsage
- name: Ingest Budgets Management V2
tags:
- ingestBudgetManagementV2
- name: Library Management
tags:
- appManagement
- appManagementV2
- contentManagement
- dashboardManagement
- folderManagement
- lookupManagement
- contentPermissions
- logSearchesManagement
- parsersLibraryManagement
- name: Metrics
tags:
- metricsSearchesManagement
- transformationRuleManagement
- metricsQuery
- metricsSearchesManagementV2
- name: Security Management
tags:
- accessKeyManagement
- oauthManagement
- accountManagement
- passwordPolicy
- policiesManagement
- samlConfigurationManagement
- serviceAllowlistManagement
- serviceAccountManagement
- scimUserManagement
- name: Organizations Management
tags:
- orgsManagement
- name: Settings Management
tags:
- connectionManagement
- dynamicParsingRuleManagement
- extractionRuleManagement
- fieldManagementV1
- partitionManagement
- scheduledViewManagement
- logsDataForwardingManagement
- dataDeletionRules
- name: Tokens Management
tags:
- tokensLibraryManagement
- name: Tracing
tags:
- traces
- spanAnalytics
- serviceMap
- name: Users and Roles Management
tags:
- roleManagement
- roleManagementV2
- userManagement
- name: Threat Intel Ingest Management
tags:
- threatIntelIngest
- threatIntelIngestProducer
- name: OpenTelemetry Collector Management
tags:
- otCollectorManagementExternal
- name: Source Template Management
tags:
- sourceTemplateManagementExternal
- name: Schema Base Management
tags:
- schemaBaseManagement
- name: Event Analytics Management
tags:
- eventAnalytics
- name: Budget Management
tags:
- budgetManagement
- name: Macro Management
tags:
- macroManagement
- name: Muting Schedules Management
tags:
- mutingSchedulesLibraryManagement
- name: SLO Management
tags:
- slosLibraryManagement
- name: Monitor Management
tags:
- monitorsLibraryManagement