Get cron trigger

curl --request GET \
  --url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}', 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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}",
  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: Bearer <token>"
  ],
]);

$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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "org_id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "target": {
    "type": "agent",
    "agent_id": "<string>"
  },
  "cron": "<string>",
  "timezone": "UTC",
  "message_template": "<string>",
  "enabled": true,
  "last_fired_at": "2023-11-07T05:31:56Z",
  "next_fire_at": "2023-11-07T05:31:56Z",
  "failure_report": {
    "message": "<string>",
    "will_retry": true,
    "failed_at": "2023-11-07T05:31:56Z"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "internal_error"
}

GET

orgs

{orgID}

projects

{projectID}

cron-triggers

{cronTriggerID}

Get cron trigger

curl --request GET \
  --url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}', 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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}",
  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: Bearer <token>"
  ],
]);

$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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "org_id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "target": {
    "type": "agent",
    "agent_id": "<string>"
  },
  "cron": "<string>",
  "timezone": "UTC",
  "message_template": "<string>",
  "enabled": true,
  "last_fired_at": "2023-11-07T05:31:56Z",
  "next_fire_at": "2023-11-07T05:31:56Z",
  "failure_report": {
    "message": "<string>",
    "will_retry": true,
    "failed_at": "2023-11-07T05:31:56Z"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "internal_error"
}

Authorizations

Authorization

string

header

required

An opaque Omnara personal or organization bearer token.

Path Parameters

orgID

string

required

Pattern: ^org_[a-z2-7]{26}$

projectID

string

required

Pattern: ^proj_[a-z2-7]{26}$

cronTriggerID

string

required

Pattern: ^cron_[a-z2-7]{26}$

Response

Cron trigger.

string

required

Pattern: ^cron_[a-z2-7]{26}$

org_id

string

required

Pattern: ^org_[a-z2-7]{26}$

project_id

string

required

Pattern: ^proj_[a-z2-7]{26}$

name

string

required

Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.

Required string length: 1 - 64

target

object

required

Option 1
Option 2

Show child attributes

cron

string

required

Standard five-field cron expression (minute, hour, day of month, month, day of week). TZ=/CRON_TZ= prefixes are rejected; set the timezone field instead.

Required string length: 9 - 256

timezone

string

default:UTC

required

IANA time zone the schedule is evaluated in.

Maximum string length: 64

message_template

string

required

Go text/template rendered on each firing to produce the message sent to the target. The template receives a trigger value with name, fired_at, and last_fired_at fields. Rendering is capped at 64 KiB of output and one second of wall-clock time, and printf width and precision specifiers are capped at 1024; a firing whose template fails to render is recorded in failure_report without sending a message.

Maximum string length: 65536

enabled

boolean

required

last_fired_at

string<date-time> | null

required

When the trigger last fired, or null if it has never fired.

next_fire_at

string<date-time> | null

required

Next scheduled firing, or null while the trigger is disabled.

failure_report

object | null

required

Most recent failed firing, or null if no firing has failed since the last successful firing.

Show child attributes

created_at

string<date-time>

required

updated_at

string<date-time>

required

API reference

Endpoints

Get cron trigger

Authorizations

Path Parameters

Response