Update a metric source
curl --request PATCH \
--url https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id} \
--header 'Content-Type: application/json' \
--header 'x-arklow-auth: <api-key>' \
--data '
{
"updates": {
"name": "<string>",
"status": "active",
"endpoint": "<string>",
"credential_id": "<string>",
"config": {
"mode": "query_range",
"path": "<string>",
"tls_skip_verify": true
},
"deleted_at": "2023-11-07T05:31:56Z",
"queries": [
{
"op": "upsert",
"id": "<string>",
"name": "<string>",
"status": "active",
"config": {
"expression": "<string>",
"rollup_seconds": 123,
"window_seconds": 123,
"group_by": [
"<string>"
],
"tags": {}
},
"identity_tag_excludes": [
"<string>"
]
}
]
}
}
'import requests
url = "https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}"
payload = { "updates": {
"name": "<string>",
"status": "active",
"endpoint": "<string>",
"credential_id": "<string>",
"config": {
"mode": "query_range",
"path": "<string>",
"tls_skip_verify": True
},
"deleted_at": "2023-11-07T05:31:56Z",
"queries": [
{
"op": "upsert",
"id": "<string>",
"name": "<string>",
"status": "active",
"config": {
"expression": "<string>",
"rollup_seconds": 123,
"window_seconds": 123,
"group_by": ["<string>"],
"tags": {}
},
"identity_tag_excludes": ["<string>"]
}
]
} }
headers = {
"x-arklow-auth": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-arklow-auth': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
updates: {
name: '<string>',
status: 'active',
endpoint: '<string>',
credential_id: '<string>',
config: {mode: 'query_range', path: '<string>', tls_skip_verify: true},
deleted_at: '2023-11-07T05:31:56Z',
queries: [
{
op: 'upsert',
id: '<string>',
name: '<string>',
status: 'active',
config: {
expression: '<string>',
rollup_seconds: 123,
window_seconds: 123,
group_by: ['<string>'],
tags: {}
},
identity_tag_excludes: ['<string>']
}
]
}
})
};
fetch('https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'updates' => [
'name' => '<string>',
'status' => 'active',
'endpoint' => '<string>',
'credential_id' => '<string>',
'config' => [
'mode' => 'query_range',
'path' => '<string>',
'tls_skip_verify' => true
],
'deleted_at' => '2023-11-07T05:31:56Z',
'queries' => [
[
'op' => 'upsert',
'id' => '<string>',
'name' => '<string>',
'status' => 'active',
'config' => [
'expression' => '<string>',
'rollup_seconds' => 123,
'window_seconds' => 123,
'group_by' => [
'<string>'
],
'tags' => [
]
],
'identity_tag_excludes' => [
'<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-arklow-auth: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}"
payload := strings.NewReader("{\n \"updates\": {\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"endpoint\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"config\": {\n \"mode\": \"query_range\",\n \"path\": \"<string>\",\n \"tls_skip_verify\": true\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"queries\": [\n {\n \"op\": \"upsert\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"config\": {\n \"expression\": \"<string>\",\n \"rollup_seconds\": 123,\n \"window_seconds\": 123,\n \"group_by\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"identity_tag_excludes\": [\n \"<string>\"\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-arklow-auth", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}")
.header("x-arklow-auth", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"updates\": {\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"endpoint\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"config\": {\n \"mode\": \"query_range\",\n \"path\": \"<string>\",\n \"tls_skip_verify\": true\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"queries\": [\n {\n \"op\": \"upsert\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"config\": {\n \"expression\": \"<string>\",\n \"rollup_seconds\": 123,\n \"window_seconds\": 123,\n \"group_by\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"identity_tag_excludes\": [\n \"<string>\"\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-arklow-auth"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"updates\": {\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"endpoint\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"config\": {\n \"mode\": \"query_range\",\n \"path\": \"<string>\",\n \"tls_skip_verify\": true\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"queries\": [\n {\n \"op\": \"upsert\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"config\": {\n \"expression\": \"<string>\",\n \"rollup_seconds\": 123,\n \"window_seconds\": 123,\n \"group_by\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"identity_tag_excludes\": [\n \"<string>\"\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"org_id": "<string>",
"name": "<string>",
"kind": "prometheus",
"status": "active",
"endpoint": "<string>",
"poll_interval_seconds": 123,
"version": "<string>",
"applied_version": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"credential_id": "<string>",
"config": {},
"last_collected_at": "2023-11-07T05:31:56Z",
"last_error": "<string>",
"last_error_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"queries": [
{
"id": "<string>",
"source_id": "<string>",
"name": "<string>",
"status": "active",
"updated_at": "2023-11-07T05:31:56Z",
"config": {
"expression": "<string>",
"rollup_seconds": 123,
"window_seconds": 123,
"group_by": [
"<string>"
],
"tags": {}
},
"identity_tag_excludes": [
"<string>"
],
"deleted_at": "2023-11-07T05:31:56Z"
}
]
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}Update a metric source
PATCH
/
v1
/
orgs
/
{org_id}
/
metrics
/
sources
/
{id}
Update a metric source
curl --request PATCH \
--url https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id} \
--header 'Content-Type: application/json' \
--header 'x-arklow-auth: <api-key>' \
--data '
{
"updates": {
"name": "<string>",
"status": "active",
"endpoint": "<string>",
"credential_id": "<string>",
"config": {
"mode": "query_range",
"path": "<string>",
"tls_skip_verify": true
},
"deleted_at": "2023-11-07T05:31:56Z",
"queries": [
{
"op": "upsert",
"id": "<string>",
"name": "<string>",
"status": "active",
"config": {
"expression": "<string>",
"rollup_seconds": 123,
"window_seconds": 123,
"group_by": [
"<string>"
],
"tags": {}
},
"identity_tag_excludes": [
"<string>"
]
}
]
}
}
'import requests
url = "https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}"
payload = { "updates": {
"name": "<string>",
"status": "active",
"endpoint": "<string>",
"credential_id": "<string>",
"config": {
"mode": "query_range",
"path": "<string>",
"tls_skip_verify": True
},
"deleted_at": "2023-11-07T05:31:56Z",
"queries": [
{
"op": "upsert",
"id": "<string>",
"name": "<string>",
"status": "active",
"config": {
"expression": "<string>",
"rollup_seconds": 123,
"window_seconds": 123,
"group_by": ["<string>"],
"tags": {}
},
"identity_tag_excludes": ["<string>"]
}
]
} }
headers = {
"x-arklow-auth": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-arklow-auth': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
updates: {
name: '<string>',
status: 'active',
endpoint: '<string>',
credential_id: '<string>',
config: {mode: 'query_range', path: '<string>', tls_skip_verify: true},
deleted_at: '2023-11-07T05:31:56Z',
queries: [
{
op: 'upsert',
id: '<string>',
name: '<string>',
status: 'active',
config: {
expression: '<string>',
rollup_seconds: 123,
window_seconds: 123,
group_by: ['<string>'],
tags: {}
},
identity_tag_excludes: ['<string>']
}
]
}
})
};
fetch('https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'updates' => [
'name' => '<string>',
'status' => 'active',
'endpoint' => '<string>',
'credential_id' => '<string>',
'config' => [
'mode' => 'query_range',
'path' => '<string>',
'tls_skip_verify' => true
],
'deleted_at' => '2023-11-07T05:31:56Z',
'queries' => [
[
'op' => 'upsert',
'id' => '<string>',
'name' => '<string>',
'status' => 'active',
'config' => [
'expression' => '<string>',
'rollup_seconds' => 123,
'window_seconds' => 123,
'group_by' => [
'<string>'
],
'tags' => [
]
],
'identity_tag_excludes' => [
'<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-arklow-auth: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}"
payload := strings.NewReader("{\n \"updates\": {\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"endpoint\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"config\": {\n \"mode\": \"query_range\",\n \"path\": \"<string>\",\n \"tls_skip_verify\": true\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"queries\": [\n {\n \"op\": \"upsert\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"config\": {\n \"expression\": \"<string>\",\n \"rollup_seconds\": 123,\n \"window_seconds\": 123,\n \"group_by\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"identity_tag_excludes\": [\n \"<string>\"\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-arklow-auth", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}")
.header("x-arklow-auth", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"updates\": {\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"endpoint\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"config\": {\n \"mode\": \"query_range\",\n \"path\": \"<string>\",\n \"tls_skip_verify\": true\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"queries\": [\n {\n \"op\": \"upsert\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"config\": {\n \"expression\": \"<string>\",\n \"rollup_seconds\": 123,\n \"window_seconds\": 123,\n \"group_by\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"identity_tag_excludes\": [\n \"<string>\"\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arklow.io/v1/orgs/{org_id}/metrics/sources/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-arklow-auth"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"updates\": {\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"endpoint\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"config\": {\n \"mode\": \"query_range\",\n \"path\": \"<string>\",\n \"tls_skip_verify\": true\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"queries\": [\n {\n \"op\": \"upsert\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"config\": {\n \"expression\": \"<string>\",\n \"rollup_seconds\": 123,\n \"window_seconds\": 123,\n \"group_by\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"identity_tag_excludes\": [\n \"<string>\"\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"org_id": "<string>",
"name": "<string>",
"kind": "prometheus",
"status": "active",
"endpoint": "<string>",
"poll_interval_seconds": 123,
"version": "<string>",
"applied_version": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"credential_id": "<string>",
"config": {},
"last_collected_at": "2023-11-07T05:31:56Z",
"last_error": "<string>",
"last_error_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"queries": [
{
"id": "<string>",
"source_id": "<string>",
"name": "<string>",
"status": "active",
"updated_at": "2023-11-07T05:31:56Z",
"config": {
"expression": "<string>",
"rollup_seconds": 123,
"window_seconds": 123,
"group_by": [
"<string>"
],
"tags": {}
},
"identity_tag_excludes": [
"<string>"
],
"deleted_at": "2023-11-07T05:31:56Z"
}
]
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}Authorizations
Body
application/json
Show child attributes
Show child attributes