List monitors

GET

api

monitors

List monitors

curl --request GET \
  --url https://us.datafold.com/api/v1/monitors \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://us.datafold.com/api/v1/monitors', 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://us.datafold.com/api/v1/monitors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://us.datafold.com/api/v1/monitors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://us.datafold.com/api/v1/monitors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "count": 123,
  "monitors": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "enabled": true,
      "id": 123,
      "managed_in_code": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "monitor_type": "diff",
      "name": "<string>",
      "last_run": "2023-11-07T05:31:56Z",
      "next_run": "2023-11-07T05:31:56Z",
      "owner": "<string>",
      "slug": "<string>",
      "state": "ok",
      "tags": [
        "<string>"
      ]
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Use the 'Authorization' header with the format 'Key '

Query Parameters

page

integer

default:1

The page number to retrieve.

Required range: x >= 1

page_size

integer

default:20

The number of monitors per page.

Required range: 1 <= x <= 200

order_by

enum<string>

default:id

Field to order the monitors by.

Available options:

id,

name,

created_at,

updated_at,

last_run_at

sort_order

enum<string>

default:desc

Order direction.

Available options:

asc,

desc

Response

Successful Response

count

integer

required

Total number of monitors visible to the caller.

monitors

ApiPublicGetMonitorOut · object[]

required

This page of monitors.

Show child attributes

page

integer

required

Current page number.

page_size

integer

required

Monitors per page.

total_pages

integer

required

Total number of pages.

⌘I

List monitors

curl --request GET \
  --url https://us.datafold.com/api/v1/monitors \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://us.datafold.com/api/v1/monitors', 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://us.datafold.com/api/v1/monitors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://us.datafold.com/api/v1/monitors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://us.datafold.com/api/v1/monitors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "count": 123,
  "monitors": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "enabled": true,
      "id": 123,
      "managed_in_code": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "monitor_type": "diff",
      "name": "<string>",
      "last_run": "2023-11-07T05:31:56Z",
      "next_run": "2023-11-07T05:31:56Z",
      "owner": "<string>",
      "slug": "<string>",
      "state": "ok",
      "tags": [
        "<string>"
      ]
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Cloud

Audit Logs

Data sources

Data diffs

Monitors

Authorizations

Query Parameters

Response