Scheduling

Create and manage scheduled test runs. Automate recurring IVR tests on a cron schedule.

7 endpoints

POST/schedules

Create a new schedule for automated test execution.

Body Parameters

Name	Type	Required	Description
name	string	required	Display name for the schedule
configId	string	required	Test configuration ID to schedule
cronExpression	string	required	Cron expression for the schedule (e.g., "0 9 * * MON-FRI")
timezone	string	optional	IANA timezone (default: UTC)

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Daily Sales Test","configId":"cfg_abc123","cronExpression":"0 9 * * MON-FRI","timezone":"Europe/London"}' \
  https://api.nopaque.co.uk/schedules

Response

json

{
  "id": "sched_abc123",
  "name": "Daily Sales Test",
  "configId": "cfg_abc123",
  "cronExpression": "0 9 * * MON-FRI",
  "timezone": "Europe/London",
  "status": "active",
  "createdAt": "2026-04-10T12: 00: 00Z"
}

GET/schedules

List all schedules in the workspace.

Query Parameters

Name	Type	Required	Description
limit	number	optional	Maximum items to return (default 50)
nextToken	string	optional	Pagination token from previous response

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/schedules

Response

json

{
  "schedules": [
    {
      "id": "sched_abc123",
      "name": "Daily Sales Test",
      "status": "active",
      "cronExpression": "0 9 * * MON-FRI"
    }
  ],
  "count": 1
}

GET/schedules/{id}

Get a specific schedule by ID.

Path Parameters

Name	Type	Required	Description
id	string	required	Schedule ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/schedules/sched_abc123

Response

json

{
  "id": "sched_abc123",
  "name": "Daily Sales Test",
  "configId": "cfg_abc123",
  "cronExpression": "0 9 * * MON-FRI",
  "timezone": "Europe/London",
  "status": "active",
  "nextRunAt": "2026-04-11T09: 00: 00Z"
}

PUT/schedules/{id}

Update a schedule configuration.

Path Parameters

Name	Type	Required	Description
id	string	required	Schedule ID

Body Parameters

Name	Type	Required	Description
name	string	optional	Updated display name
cronExpression	string	optional	Updated cron expression
timezone	string	optional	Updated timezone

Request

bash

curl -X PUT -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cronExpression":"0 8 * * MON-FRI"}' \
  https://api.nopaque.co.uk/schedules/sched_abc123

Response

json

{
  "id": "sched_abc123",
  "cronExpression": "0 8 * * MON-FRI",
  "updatedAt": "2026-04-10T12: 10: 00Z"
}

DELETE/schedules/{id}

Delete a schedule.

Path Parameters

Name	Type	Required	Description
id	string	required	Schedule ID

Request

bash

curl -X DELETE -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/schedules/sched_abc123

Response

json

{
  "message": "Schedule deleted successfully"
}

POST/schedules/{id}/pause

Pause an active schedule. Scheduled runs will not execute until resumed.

Path Parameters

Name	Type	Required	Description
id	string	required	Schedule ID

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/schedules/sched_abc123/pause

Response

json

{
  "id": "sched_abc123",
  "status": "paused",
  "pausedAt": "2026-04-10T12: 15: 00Z"
}

POST/schedules/{id}/resume

Resume a paused schedule.

Path Parameters

Name	Type	Required	Description
id	string	required	Schedule ID

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/schedules/sched_abc123/resume

Response

json

{
  "id": "sched_abc123",
  "status": "active",
  "resumedAt": "2026-04-10T12: 20: 00Z"
}