Update External Link

Update External Link

Update a specific external link

Request
URI
PUT
https://{api_host}/api/v2/extlink/{id}
COPY
Path Parameters
string
id
Required

id

Request Body
ExternalLink of type(s) application/json
Optional 
{
    "name": "string",
    "id": "string",
    "description": "string",
    "createdEpochMillis": 0,
    "updatedEpochMillis": 0,
    "template": "string",
    "metricFilterRegex": "string",
    "sourceFilterRegex": "string",
    "isLogIntegration": false,
    "creatorId": "string",
    "updaterId": "string"
}
string
name
Required

Name of the external link. Will be displayed in context (right-click) menus on charts

string
id
Optional

id

string
description
Required

Human-readable description for this external link

integer As int64 As int64
createdEpochMillis
Optional

createdEpochMillis

integer As int64 As int64
updatedEpochMillis
Optional

updatedEpochMillis

string
template
Required

The mustache template for this link. This template must expand to a full URL, including scheme, origin, etc

string
metricFilterRegex
Optional

Controls whether a link displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed

string
sourceFilterRegex
Optional

Controls whether a link displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed

object
pointTagFilterRegexes
Optional

Controls whether a link displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed

boolean
isLogIntegration
Optional

Whether this is a "Log Integration" subType of external link

string
creatorId
Optional

creatorId

string
updaterId
Optional

updaterId

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResponseContainerExternalLink of type(s) application/json 
{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "name": "string",
        "id": "string",
        "description": "string",
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "template": "string",
        "metricFilterRegex": "string",
        "sourceFilterRegex": "string",
        "isLogIntegration": false,
        "creatorId": "string",
        "updaterId": "string"
    }
}
ResponseStatus
status
Required

status

ExternalLink
response
Optional

response


On This Page
External Link Operations
POST
Create External Link
DELETE
Delete External Link
GET
Get All External Link
GET
Get External Link
PUT
Update External Link