Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
sourceTemplateManagementExternal

Upgrade source template (deprecated).

Upgrade a source template with the given identifier.

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

post/v1/upgrade/sourceTemplate/{id}

Path parameters

idstring required

Identifier of the source template to upgrade.

Request body

Example request

{
  "schemaRef": {
    "type": "Apache",
    "version": "1.0.0"
  },
  "inputJson": {
    "name": "apache_test_source_template",
    "receivers": {
      "hostmetrics": {
        "receiverType": "hostmetrics",
        "collection_interval": "5m"
      }
    },
    "description": "Demo Description for source template",
    "processors": {
      "resource": {
        "processorType": "resource"
      }
    }
  }
}

Response

Upgrade source template response

idstring

id of source template.

inputJsonobject

inputJson of source template

configstring

configuration of source template

totalCollectorLinkedinteger

count of total collector linked with this source template.

createdAtstring date-time

Creation timestamp in UTC in RFC3339 format.

modifiedAtstring date-time

Modification timestamp in UTC in RFC3339 format.

createdBystring

Id of the user who created source template

modifiedBystring

Id of the user who last modified the source template

status'enable' | 'disable'

Status of Source template

isEnabledboolean

A boolean parameter to get if the source template is enabled.

Example response

{
  "schemaRef": {
    "type": "Apache"
  },
  "id": "0000000003343FDD",
  "inputJson": {},
  "config": "apache.yaml.example",
  "selector": {
    "tags": [
      [
        {
          "key": "key1",
          "values": [
            "value1"
          ]
        }
      ]
    ],
    "names": [
      "demo_macOS"
    ]
  },
  "createdAt": "2018-10-16T09:10:00Z",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedBy": "0000000006243FDD",
  "isEnabled": true
}