Create Source

Create Source

Create metadata (description or tags) for a specific source

Request
URI
POST
https://{api_host}/api/v2/source
COPY
Request Body
Source of type(s) application/json
Optional
{
    "hidden": false,
    "id": "string",
    "description": "string",
    "createdEpochMillis": 0,
    "updatedEpochMillis": 0,
    "markedNewEpochMillis": 0,
    "creatorId": "string",
    "updaterId": "string",
    "sourceName": "string"
}
boolean
hidden
Optional

A derived field denoting whether this source has been hidden (e.g. excluding it from query autocomplete among other things)

string
id
Required

id of this source, must be exactly equivalent to 'sourceName'

string
description
Optional

Description of this source

integer As int64 As int64
createdEpochMillis
Optional

createdEpochMillis

integer As int64 As int64
updatedEpochMillis
Optional

updatedEpochMillis

object
tags
Optional

A Map (String -> boolean) Representing the source tags associated with this source. To create a tag, set it as a KEY in this map, with associated value equal to true

integer As int64 As int64
markedNewEpochMillis
Optional

Epoch Millis when this source was marked as ~status.new

string
creatorId
Optional

creatorId

string
updaterId
Optional

updaterId

string
sourceName
Required

The name of the source, usually set by ingested telemetry

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResponseContainerSource of type(s) application/json
{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "hidden": false,
        "id": "string",
        "description": "string",
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "markedNewEpochMillis": 0,
        "creatorId": "string",
        "updaterId": "string",
        "sourceName": "string"
    }
}
status
Required

status

response
Optional

response