Update a source
curl --request PATCH \
--url https://api.arklow.io/v1/orgs/{org_id}/sources/{id} \
--header 'Content-Type: application/json' \
--header 'x-arklow-auth: <api-key>' \
--data '
{
"type": "aws_sqs",
"config": {
"queue_url": "<string>",
"region": "<string>"
},
"name": "<string>",
"status": "active",
"ingest": {
"variant": "<string>",
"version": 2
},
"tag_mappings": {},
"auto_tag_attributes": true,
"credential_id": "<string>",
"runtime": {
"min_shards": 8,
"max_shards": 8
},
"deleted_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.arklow.io/v1/orgs/{org_id}/sources/{id}"
payload = {
"type": "aws_sqs",
"config": {
"queue_url": "<string>",
"region": "<string>"
},
"name": "<string>",
"status": "active",
"ingest": {
"variant": "<string>",
"version": 2
},
"tag_mappings": {},
"auto_tag_attributes": True,
"credential_id": "<string>",
"runtime": {
"min_shards": 8,
"max_shards": 8
},
"deleted_at": "2023-11-07T05:31:56Z"
}
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({
type: 'aws_sqs',
config: {queue_url: '<string>', region: '<string>'},
name: '<string>',
status: 'active',
ingest: {variant: '<string>', version: 2},
tag_mappings: {},
auto_tag_attributes: true,
credential_id: '<string>',
runtime: {min_shards: 8, max_shards: 8},
deleted_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.arklow.io/v1/orgs/{org_id}/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}/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([
'type' => 'aws_sqs',
'config' => [
'queue_url' => '<string>',
'region' => '<string>'
],
'name' => '<string>',
'status' => 'active',
'ingest' => [
'variant' => '<string>',
'version' => 2
],
'tag_mappings' => [
],
'auto_tag_attributes' => true,
'credential_id' => '<string>',
'runtime' => [
'min_shards' => 8,
'max_shards' => 8
],
'deleted_at' => '2023-11-07T05:31:56Z'
]),
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}/sources/{id}"
payload := strings.NewReader("{\n \"type\": \"aws_sqs\",\n \"config\": {\n \"queue_url\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"ingest\": {\n \"variant\": \"<string>\",\n \"version\": 2\n },\n \"tag_mappings\": {},\n \"auto_tag_attributes\": true,\n \"credential_id\": \"<string>\",\n \"runtime\": {\n \"min_shards\": 8,\n \"max_shards\": 8\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\"\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}/sources/{id}")
.header("x-arklow-auth", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"aws_sqs\",\n \"config\": {\n \"queue_url\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"ingest\": {\n \"variant\": \"<string>\",\n \"version\": 2\n },\n \"tag_mappings\": {},\n \"auto_tag_attributes\": true,\n \"credential_id\": \"<string>\",\n \"runtime\": {\n \"min_shards\": 8,\n \"max_shards\": 8\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arklow.io/v1/orgs/{org_id}/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 \"type\": \"aws_sqs\",\n \"config\": {\n \"queue_url\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"ingest\": {\n \"variant\": \"<string>\",\n \"version\": 2\n },\n \"tag_mappings\": {},\n \"auto_tag_attributes\": true,\n \"credential_id\": \"<string>\",\n \"runtime\": {\n \"min_shards\": 8,\n \"max_shards\": 8\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"org_id": "<string>",
"name": "<string>",
"status": "active",
"ingest": {
"variant": "<string>",
"version": 2
},
"auto_tag_attributes": true,
"runtime": {
"min_shards": 2,
"max_shards": 2,
"desired_shards": 2,
"max_inflight": 2,
"poll_wait_seconds": 2,
"lease_ttl_seconds": 2,
"heartbeat_seconds": 2
},
"version": "<string>",
"applied_version": "<string>",
"generation": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"type": "aws_sqs",
"config": {
"queue_url": "<string>",
"region": "<string>"
},
"tag_mappings": {},
"planner_updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"credential_id": "<string>"
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}Update a source
PATCH
/
v1
/
orgs
/
{org_id}
/
sources
/
{id}
Update a source
curl --request PATCH \
--url https://api.arklow.io/v1/orgs/{org_id}/sources/{id} \
--header 'Content-Type: application/json' \
--header 'x-arklow-auth: <api-key>' \
--data '
{
"type": "aws_sqs",
"config": {
"queue_url": "<string>",
"region": "<string>"
},
"name": "<string>",
"status": "active",
"ingest": {
"variant": "<string>",
"version": 2
},
"tag_mappings": {},
"auto_tag_attributes": true,
"credential_id": "<string>",
"runtime": {
"min_shards": 8,
"max_shards": 8
},
"deleted_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.arklow.io/v1/orgs/{org_id}/sources/{id}"
payload = {
"type": "aws_sqs",
"config": {
"queue_url": "<string>",
"region": "<string>"
},
"name": "<string>",
"status": "active",
"ingest": {
"variant": "<string>",
"version": 2
},
"tag_mappings": {},
"auto_tag_attributes": True,
"credential_id": "<string>",
"runtime": {
"min_shards": 8,
"max_shards": 8
},
"deleted_at": "2023-11-07T05:31:56Z"
}
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({
type: 'aws_sqs',
config: {queue_url: '<string>', region: '<string>'},
name: '<string>',
status: 'active',
ingest: {variant: '<string>', version: 2},
tag_mappings: {},
auto_tag_attributes: true,
credential_id: '<string>',
runtime: {min_shards: 8, max_shards: 8},
deleted_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.arklow.io/v1/orgs/{org_id}/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}/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([
'type' => 'aws_sqs',
'config' => [
'queue_url' => '<string>',
'region' => '<string>'
],
'name' => '<string>',
'status' => 'active',
'ingest' => [
'variant' => '<string>',
'version' => 2
],
'tag_mappings' => [
],
'auto_tag_attributes' => true,
'credential_id' => '<string>',
'runtime' => [
'min_shards' => 8,
'max_shards' => 8
],
'deleted_at' => '2023-11-07T05:31:56Z'
]),
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}/sources/{id}"
payload := strings.NewReader("{\n \"type\": \"aws_sqs\",\n \"config\": {\n \"queue_url\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"ingest\": {\n \"variant\": \"<string>\",\n \"version\": 2\n },\n \"tag_mappings\": {},\n \"auto_tag_attributes\": true,\n \"credential_id\": \"<string>\",\n \"runtime\": {\n \"min_shards\": 8,\n \"max_shards\": 8\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\"\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}/sources/{id}")
.header("x-arklow-auth", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"aws_sqs\",\n \"config\": {\n \"queue_url\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"ingest\": {\n \"variant\": \"<string>\",\n \"version\": 2\n },\n \"tag_mappings\": {},\n \"auto_tag_attributes\": true,\n \"credential_id\": \"<string>\",\n \"runtime\": {\n \"min_shards\": 8,\n \"max_shards\": 8\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arklow.io/v1/orgs/{org_id}/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 \"type\": \"aws_sqs\",\n \"config\": {\n \"queue_url\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"status\": \"active\",\n \"ingest\": {\n \"variant\": \"<string>\",\n \"version\": 2\n },\n \"tag_mappings\": {},\n \"auto_tag_attributes\": true,\n \"credential_id\": \"<string>\",\n \"runtime\": {\n \"min_shards\": 8,\n \"max_shards\": 8\n },\n \"deleted_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"org_id": "<string>",
"name": "<string>",
"status": "active",
"ingest": {
"variant": "<string>",
"version": 2
},
"auto_tag_attributes": true,
"runtime": {
"min_shards": 2,
"max_shards": 2,
"desired_shards": 2,
"max_inflight": 2,
"poll_wait_seconds": 2,
"lease_ttl_seconds": 2,
"heartbeat_seconds": 2
},
"version": "<string>",
"applied_version": "<string>",
"generation": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"type": "aws_sqs",
"config": {
"queue_url": "<string>",
"region": "<string>"
},
"tag_mappings": {},
"planner_updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"credential_id": "<string>"
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}Authorizations
Body
application/json
- Option 1
- Option 2
Available options:
aws_sqs Show child attributes
Show child attributes
Available options:
active Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^[0-9]+$Show child attributes
Show child attributes