openapi: 3.0.0
info:
  title: Sumo Logic accessKeyManagement sourceTemplateManagementExternal 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: sourceTemplateManagementExternal
  description: 'Source Template Management APIs.

    '
  x-displayName: Source Template Management
paths:
  /v1/sourceTemplates:
    get:
      tags:
      - sourceTemplateManagementExternal
      summary: List All Source Templates.
      description: Get a list of all source templates.
      operationId: getSourceTemplatesV2
      parameters:
      - name: showDisabled
        in: query
        description: A boolean parameter to get all, including disabled source templates.
        required: false
        schema:
          type: boolean
          default: false
      - name: name
        in: query
        description: Only return source template matching the given name (exact match).
        required: false
        schema:
          minLength: 1
          type: string
          nullable: true
      responses:
        '200':
          description: A list of source templates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateListResponse'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - sourceTemplateManagementExternal
      summary: Create Source Template.
      description: Create source template.
      operationId: createSourceTemplateV2
      requestBody:
        description: Create source template details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceTemplateRequest'
        required: true
      responses:
        '200':
          description: Create source template response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/sourceTemplates/{id}:
    get:
      tags:
      - sourceTemplateManagementExternal
      summary: Get A Source Template By Id.
      description: Get a source template with the given identifier.
      operationId: getSourceTemplateV2
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Get source template response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - sourceTemplateManagementExternal
      summary: Update Source Template.
      description: Update a source template with the given identifier.
      operationId: updateSourceTemplateV2
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to update.
        required: true
        schema:
          type: string
      requestBody:
        description: Request details of update source template.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceTemplateUpdateRequest'
        required: true
      responses:
        '200':
          description: Update source template response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - sourceTemplateManagementExternal
      summary: Delete A Source Template.
      description: Delete a source template with the given identifier.
      operationId: deleteSourceTemplateV2
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The source template was deleted successfully.
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/sourceTemplates/{id}/status:
    put:
      tags:
      - sourceTemplateManagementExternal
      summary: Update Status Of Source Template
      description: Update the status (enable or disable) of a source template.
      operationId: updateSourceTemplateStatusV2
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to update.
        required: true
        schema:
          type: string
      requestBody:
        description: Status of source template
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceTemplateStatusUpdateRequest'
        required: true
      responses:
        '200':
          description: Update source template status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/sourceTemplates/{id}/upgrade:
    post:
      tags:
      - sourceTemplateManagementExternal
      summary: Upgrade Source Template.
      description: Upgrade a source template with the given identifier.
      operationId: upgradeSourceTemplateV2
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to upgrade.
        required: true
        schema:
          type: string
      requestBody:
        description: Source template upgrade request details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceTemplateUpgradeRequest'
        required: true
      responses:
        '200':
          description: Upgrade source template response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/sourceTemplates/getLinkedSourceTemplatesImpact:
    post:
      tags:
      - sourceTemplateManagementExternal
      summary: Preview Source Template Linking Changes.
      description: Given the set of tags user wants to update, display the list of source templates that will be linked/unlinked to the otCollector.
      operationId: getLinkedSourceTemplatesImpact
      requestBody:
        description: Request body containing otCollector id and set of tags.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedSourceTemplatesUpdateRequest'
        required: true
      responses:
        '200':
          description: A list of source templates whose linking to the otCollector will be impacted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedSourceTemplatesUpdateResponse'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/sourceTemplate:
    get:
      tags:
      - sourceTemplateManagementExternal
      summary: Return All Source Templates Of A Customer (deprecated).
      description: 'Get a list of source template.


        **DEPRECATED**: This endpoint will be removed soon. Please use GET /v1/sourceTemplates instead.

        '
      operationId: getSourceTemplates
      parameters:
      - name: showDisabled
        in: query
        description: A boolean parameter to get all, including disabled source templates.
        required: false
        schema:
          type: boolean
          default: false
      - name: name
        in: query
        description: Only return source template matching the given name (exact match).
        required: false
        schema:
          minLength: 1
          type: string
          nullable: true
      responses:
        '200':
          description: A list of source templates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateListResponse'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
    post:
      tags:
      - sourceTemplateManagementExternal
      summary: Create Source Template (deprecated).
      description: 'Create source template.


        **DEPRECATED**: This endpoint will be removed soon. Please use POST /v1/sourceTemplates instead.

        '
      operationId: createSourceTemplate
      requestBody:
        description: Create source template details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceTemplateRequest'
        required: true
      responses:
        '200':
          description: Create source template response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
  /v1/sourceTemplate/{id}:
    get:
      tags:
      - sourceTemplateManagementExternal
      summary: Get A Source Template By Id (deprecated).
      description: 'Get a source template with the given identifier.


        **DEPRECATED**: This endpoint will be removed soon. Please use GET /v1/sourceTemplates/{id} instead.

        '
      operationId: getSourceTemplate
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Get source template response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
    post:
      tags:
      - sourceTemplateManagementExternal
      summary: Update Source Template (deprecated).
      description: 'Update a source template with the given identifier.


        **DEPRECATED**: This endpoint will be removed soon. Please use POST /v1/sourceTemplates/{id} instead.

        '
      operationId: updateSourceTemplate
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to update.
        required: true
        schema:
          type: string
      requestBody:
        description: Source template request details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceTemplateRequest'
        required: true
      responses:
        '200':
          description: Update source template response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
    delete:
      tags:
      - sourceTemplateManagementExternal
      summary: Delete A Source Template (deprecated).
      description: 'Delete a source template with the given identifier.


        **DEPRECATED**: This endpoint will be removed soon. Please use DELETE /v1/sourceTemplates/{id} instead.

        '
      operationId: deleteSourceTemplate
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The source template was deleted successfully.
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
  /v1/upgrade/sourceTemplate/{id}:
    post:
      tags:
      - sourceTemplateManagementExternal
      summary: Upgrade Source Template (deprecated).
      description: 'Upgrade a source template with the given identifier.


        **DEPRECATED**: This endpoint will be removed soon. Please use POST /v1/sourceTemplates/{id}/upgrade instead.

        '
      operationId: upgradeSourceTemplate
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to upgrade.
        required: true
        schema:
          type: string
      requestBody:
        description: Source template upgrade request details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceTemplateUpgradeRequest'
        required: true
      responses:
        '200':
          description: Upgrade source template response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
  /v1/sourceTemplate/getLinkedSourceTemplatesImpact:
    post:
      tags:
      - sourceTemplateManagementExternal
      summary: Get Linked Source Templates Update Based On The Ot-collector Tags User Is Wants To Update.
      description: Given the set of tags user wants to update, display the list of source templates that will be linked/unlinked to the otCollector.
      operationId: getLinkedSourceTemplatesUpdate
      requestBody:
        description: Request body containing otCollector id and set of tags.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedSourceTemplatesUpdateRequest'
        required: true
      responses:
        '200':
          description: A list of source templates whose linking to the otCollector will be impacted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedSourceTemplatesUpdateResponse'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/sourceTemplate/{id}/status:
    put:
      tags:
      - sourceTemplateManagementExternal
      summary: Update Status Of Source Template (deprecated)
      description: 'Update the status (enable or disable) of a source template.


        **DEPRECATED**: This endpoint will be removed soon. Please use PUT /v1/sourceTemplates/{id}/status instead.

        '
      operationId: updateSourceTemplateStatus
      parameters:
      - name: id
        in: path
        description: Identifier of the source template to update.
        required: true
        schema:
          type: string
      requestBody:
        description: Status of source template
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceTemplateStatusUpdateRequest'
        required: true
      responses:
        '200':
          description: Update source template status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceTemplateDefinition'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
components:
  schemas:
    LinkedSourceTemplatesUpdateResponse:
      required:
      - collectorId
      type: object
      properties:
        collectorId:
          type: string
          description: otCollector id for which tags are edited.
          example: 00005AF3107BF0D6
        addedSourceTemplates:
          type: array
          description: list of sourceTemplates which are linked to otCollector.
          items:
            $ref: '#/components/schemas/LinkingUpdatedSourceTemplateDetails'
        removedSourceTemplates:
          type: array
          description: list of sourceTemplates which are removed from otCollector linking.
          items:
            $ref: '#/components/schemas/LinkingUpdatedSourceTemplateDetails'
      description: linked source template details based on the ot-collector tags user wants to update.
    CollectorTag:
      required:
      - key
      - values
      type: object
      properties:
        key:
          type: string
          description: Key of the given tag.
          example: key1
        value:
          type: string
          description: Values of the given tag.
          example: value1
    SourceTemplateDefinition:
      type: object
      properties:
        schemaRef:
          $ref: '#/components/schemas/SchemaRef'
        id:
          type: string
          description: id of source template.
          example: 0000000003343FDD
        inputJson:
          maxProperties: 1000
          type: object
          additionalProperties: true
          description: inputJson of source template
          example: {}
        config:
          type: string
          description: configuration of source template
          example: apache.yaml.example
        selector:
          $ref: '#/components/schemas/Selector'
        totalCollectorLinked:
          type: integer
          description: count of total collector linked with this source template.
          format: int32
          default: 0
        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
        modifiedAt:
          type: string
          description: Modification 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: Id of the user who created source template
          example: 0000000006743FDD
        modifiedBy:
          type: string
          description: Id of the user who last modified the source template
          example: 0000000006243FDD
        status:
          type: string
          description: Status of Source template
          enum:
          - enable
          - disable
        isEnabled:
          type: boolean
          description: A boolean parameter to get if the source template is enabled.
          example: true
          default: true
      description: response definition of source template.
    SourceTemplateUpdateRequest:
      required:
      - inputJson
      - schemaRef
      type: object
      properties:
        schemaRef:
          $ref: '#/components/schemas/SchemaRef'
        inputJson:
          maxProperties: 1000
          required:
          - name
          - receivers
          type: object
          properties:
            name:
              type: string
              description: Name of source template.
              example: apache_test_source_template
            receivers:
              type: object
              description: Receiver information of source template
              example: {}
            description:
              type: string
              description: Description of source template
              example: Demo Description for source template
            processors:
              type: object
              description: Processors for source template
              example: {}
          additionalProperties: true
          description: InputJson of source template
        selector:
          $ref: '#/components/schemas/Selector'
        isEnabled:
          type: boolean
          description: Indicates whether the source template is enabled. If omitted, the existing status is preserved.
          example: true
      description: Request body for updating source template.
    UpgradeSchemaRef:
      required:
      - type
      - version
      type: object
      properties:
        type:
          type: string
          description: type of source template.
          example: Apache
        version:
          type: string
          description: version of source template.
          example: 1.0.0
      description: schema reference for upgrade source template request.
    SourceTemplateStatusUpdateRequest:
      required:
      - status
      type: object
      properties:
        status:
          type: string
          description: status to set for the source template (enable or disable).
          enum:
          - enable
          - disable
      example:
        status: enable
    SchemaRef:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: type of source template.
          example: Apache
      description: schema reference for source template.
    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
    LinkedSourceTemplatesUpdateRequest:
      required:
      - collectorId
      type: object
      properties:
        collectorId:
          type: string
          description: otCollector id for which tags are edited.
          example: 00005AF3107BF0D6
        tags:
          maxProperties: 50
          type: object
          additionalProperties:
            type: string
          description: JSON map of key-value metadata to apply to the otCollector.
          example:
            environment: production
            location: us-west-2
          default: {}
        updatedName:
          type: string
          description: Updated Name of the otCollector.
          example: demo_macOS
    SourceTemplateUpgradeRequest:
      required:
      - inputJson
      - schemaRef
      type: object
      properties:
        schemaRef:
          $ref: '#/components/schemas/UpgradeSchemaRef'
        inputJson:
          maxProperties: 1000
          required:
          - name
          - receivers
          type: object
          properties:
            name:
              type: string
              description: name of source template.
              example: apache_test_source_template
            receivers:
              type: object
              description: receiver information of source template
              example:
                hostmetrics:
                  receiverType: hostmetrics
                  collection_interval: 5m
            description:
              type: string
              description: description of source template
              example: Demo Description for source template
            processors:
              type: object
              description: processors for source template
              example:
                resource:
                  processorType: resource
          additionalProperties: true
          description: inputJson of source template
      description: request body for creating source template.
    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'
    SourceTemplateRequest:
      required:
      - inputJson
      - schemaRef
      type: object
      properties:
        schemaRef:
          $ref: '#/components/schemas/SchemaRef'
        inputJson:
          maxProperties: 1000
          required:
          - name
          - receivers
          type: object
          properties:
            name:
              type: string
              description: name of source template.
              example: apache_test_source_template
            receivers:
              type: object
              description: receiver information of source template
              example: {}
            description:
              type: string
              description: description of source template
              example: Demo Description for Source Template
            processors:
              type: object
              description: processors for source template
              example: {}
          additionalProperties: true
          description: inputJson of source template
        selector:
          $ref: '#/components/schemas/Selector'
        isEnabled:
          type: boolean
          description: Indicates whether the source template is enabled - **Create operation:** Defaults to `true` (the template is enabled when created). - **Update operation:** If omitted, the existing status is preserved.
          example: true
      description: request body for creating source template.
    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
    LinkingUpdatedSourceTemplateDetails:
      required:
      - reasonTags
      - sourceTemplateDefinition
      type: object
      properties:
        sourceTemplateDefinition:
          $ref: '#/components/schemas/SourceTemplateDefinition'
        reasonTags:
          type: array
          description: tags which are responsible for source template and collector linking impact.
          items:
            type: array
            items:
              $ref: '#/components/schemas/CollectorTag'
      description: source template details with tags responsible for otCollector Linking update.
    Selector:
      type: object
      properties:
        tags:
          type: array
          description: tags filter for agents
          items:
            type: array
            items:
              $ref: '#/components/schemas/OtTag'
        names:
          type: array
          description: names to select custom agents
          items:
            type: string
            example: demo_macOS
      description: Agent selector conditions
    SourceTemplateListResponse:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          description: List of source templates.
          items:
            $ref: '#/components/schemas/SourceTemplateDefinition'
  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