List Jobs

GET

jobs

List Jobs

curl --request GET \
  --url https://cronho.st/api/v1/jobs \
  --header 'x-api-key: <api-key>'

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

fetch('https://cronho.st/api/v1/jobs', 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://cronho.st/api/v1/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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://cronho.st/api/v1/jobs"

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

	req.Header.Add("x-api-key", "<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://cronho.st/api/v1/jobs")

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

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

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

{
  "data": {
    "jobs": [
      {
        "id": "job_456",
        "scheduleId": "schedule_123",
        "status": "SUCCESS",
        "scheduledRunAtUtc": "2024-01-14T14:00:00.000Z",
        "attemptNumber": 1,
        "httpMethod": "GET",
        "endpoint": "https://api.example.com/health",
        "body": null,
        "headers": "{\"User-Agent\": \"Cronhost-Monitor\"}",
        "statusCode": 200,
        "response": "{\"status\": \"ok\", \"uptime\": 99.9}",
        "startedAtUtc": "2024-01-14T14:00:01.000Z",
        "completedAtUtc": "2024-01-14T14:00:02.500Z",
        "errorMessage": null,
        "createdAt": "2024-01-14T14:00:00.000Z",
        "updatedAt": "2024-01-14T14:00:02.500Z"
      }
    ],
    "page": 1,
    "pageSize": 20,
    "totalPages": 1,
    "total": 1
  },
  "success": true
}

Authorizations

x-api-key

string

header

required

API key for authentication. Get your API key from the Cronhost dashboard.

Query Parameters

scheduleId

string

required

The schedule whose jobs to list. Required.

Example:

"schedule_123"

status

enum<string>

Filter jobs by execution status

Available options:

PENDING,

RUNNING,

SUCCESS,

FAILED

Example:

"SUCCESS"

page

integer

default:1

Page number for pagination (1-based)

Required range: x >= 1

Example:

1

pageSize

integer

default:20

Number of jobs per page (1-100). limit is accepted as an alias for backward compatibility.

Required range: 1 <= x <= 100

Example:

20

Response

Successfully retrieved jobs

data

object

required

Show child attributes

success

boolean

required

Example:

true

List Jobs

curl --request GET \
  --url https://cronho.st/api/v1/jobs \
  --header 'x-api-key: <api-key>'

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

fetch('https://cronho.st/api/v1/jobs', 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://cronho.st/api/v1/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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://cronho.st/api/v1/jobs"

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

	req.Header.Add("x-api-key", "<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://cronho.st/api/v1/jobs")

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

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

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

{
  "data": {
    "jobs": [
      {
        "id": "job_456",
        "scheduleId": "schedule_123",
        "status": "SUCCESS",
        "scheduledRunAtUtc": "2024-01-14T14:00:00.000Z",
        "attemptNumber": 1,
        "httpMethod": "GET",
        "endpoint": "https://api.example.com/health",
        "body": null,
        "headers": "{\"User-Agent\": \"Cronhost-Monitor\"}",
        "statusCode": 200,
        "response": "{\"status\": \"ok\", \"uptime\": 99.9}",
        "startedAtUtc": "2024-01-14T14:00:01.000Z",
        "completedAtUtc": "2024-01-14T14:00:02.500Z",
        "errorMessage": null,
        "createdAt": "2024-01-14T14:00:00.000Z",
        "updatedAt": "2024-01-14T14:00:02.500Z"
      }
    ],
    "page": 1,
    "pageSize": 20,
    "totalPages": 1,
    "total": 1
  },
  "success": true
}

Getting Started

Schedule Endpoints

Job Endpoints

Notification Channel Endpoints

Schedule Notification Endpoints

Authorizations

Query Parameters

Response