Save routine

Creates or updates the routine of a suite. A routine is off until you enable it and always has a monthly budget: at the budget it pauses and sends arena.schedule.paused. Saving it enabled again resumes it. It runs on its schedule, and optionally after a change to the assistant's configuration or a platform release. PUT replaces the whole routine: every field you leave out takes its default (enabled: false, cadence: daily, weekday: null, window_start: 02:00, window_end: 05:00, timezone: Europe/Amsterdam, repeats: 3, webhook_url: null, on_config_change: false, on_platform_release: false, notify_email: true). Send the full routine each time, for example what GET returned with your changes.

Authorization

BearerAuth

AuthorizationBearer <token>

API key authentication. Get your key from the dashboard.

In: header

Path Parameters

suite_id*string

Test suite ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled?boolean

A routine is off until you enable it

Defaultfalse

cadence?string

Default"daily"

Value in"daily" | "weekly"

weekday?|

Required for weekly: 0 is Sunday

Range0 <= value <= 6

window_start?string

Start of the window, HH:MM in timezone

Match^([01]\d|2[0-3]):[0-5]\d$

window_end?string

End of the window, HH:MM; each routine starts at a fixed moment within it

Match^([01]\d|2[0-3]):[0-5]\d$

timezone?string

Default"Europe/Amsterdam"

repeats?integer

Default3

Range1 <= value <= 5

monthly_budget_eur*number

More than 0, at most 10000

Range0 < value <= 10000

on_config_change?boolean

Also run after the configuration of the assistant changed (after 15 quiet minutes)

Defaultfalse

on_platform_release?boolean

Also run after a platform release

Defaultfalse

webhook_url?|

Where the arena events go; defaults to your organization webhook. https only, to a public host name: no user name or password, no IP address, no localhost or internal name (such as .local, .internal or .lan), and no port other than 443.

Formaturi

Lengthlength <= 2000

notify_email?boolean

Also e-mail regressions and pauses to the owners and admins of your organization

Defaulttrue

Response Body

`application/json`

curl -X PUT "https://example.com/arena/suites/497f6eca-6276-4993-bfeb-53cbbbba6f08/schedule" \  -H "Content-Type: application/json" \  -d '{    "monthly_budget_eur": 1  }'

{
  "arena_schedule": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "suite_id": "3e9c08eb-436b-4d4b-9cfe-ca21d8bdb99b",
    "enabled": true,
    "cadence": "daily",
    "weekday": 0,
    "window_start": "string",
    "window_end": "string",
    "timezone": "string",
    "repeats": 0,
    "monthly_budget_eur": 0,
    "spent_this_month_eur": 0,
    "estimated_run_credits": 0,
    "on_config_change": true,
    "on_platform_release": true,
    "webhook_url": "string",
    "notify_email": true,
    "paused_reason": "budget",
    "paused_detail": "string",
    "paused_at": "2019-08-24T14:15:22Z",
    "next_run_at": "2019-08-24T14:15:22Z",
    "last_run_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "Invalid API key",
  "message": "string"
}

{
  "error": "Invalid API key",
  "message": "string"
}

{
  "error": "Invalid API key",
  "message": "string"
}

{
  "error": "Invalid API key",
  "message": "string"
}

Save routine

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`