Update cron trigger

curl --request PATCH \
  --url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cron": "<string>",
  "timezone": "UTC",
  "message_template": "<string>",
  "enabled": true
}
'

import requests

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

payload = {
    "name": "<string>",
    "cron": "<string>",
    "timezone": "UTC",
    "message_template": "<string>",
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    cron: '<string>',
    timezone: 'UTC',
    message_template: '<string>',
    enabled: true
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'cron' => '<string>',
    'timezone' => 'UTC',
    'message_template' => '<string>',
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"message_template\": \"<string>\",\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"message_template\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();

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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"message_template\": \"<string>\",\n  \"enabled\": true\n}"

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": "invalid_request"
}

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

PATCH

orgs

{orgID}

projects

{projectID}

cron-triggers

{cronTriggerID}

Update cron trigger

curl --request PATCH \
  --url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cron": "<string>",
  "timezone": "UTC",
  "message_template": "<string>",
  "enabled": true
}
'

import requests

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

payload = {
    "name": "<string>",
    "cron": "<string>",
    "timezone": "UTC",
    "message_template": "<string>",
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    cron: '<string>',
    timezone: 'UTC',
    message_template: '<string>',
    enabled: true
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'cron' => '<string>',
    'timezone' => 'UTC',
    'message_template' => '<string>',
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"message_template\": \"<string>\",\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"message_template\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();

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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"message_template\": \"<string>\",\n  \"enabled\": true\n}"

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": "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}$

Body

application/json

name

string

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

Required string length: 1 - 64

cron

string

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

IANA time zone the schedule is evaluated in.

Maximum string length: 64

message_template

string

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

Response

Cron trigger updated.

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

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

Update cron trigger

Authorizations

Path Parameters

Body

Response