Test Schedule Resources

Retrieve and modify a test's schedules.


Test Schedule List

Get the list of schedules for a test.

Request

GET/buckets/<bucket_key>/tests/<test_id>/schedules

Response

Returns a list of the test's schedules.

Data Attributes
id The unique ID for this schedule.
note A human-friendly description for the schedule.
environment_id The id of the environment to use when running the test.
interval The schedule's interval, must be one of:
  • 1m — every minute
  • 5m — every 5 minutes
  • 15m — every 15 minutes
  • 30m — every 30 minutes
  • 1h — every hour
  • 6h — every 6 hours
  • 1d — every day

Example Response

{
    "data": [
        {
            "environment_id": "1eeb3695-5d0f-467c-9d51-8b773dce29ba",
            "interval": "1h",
            "note": "Staging Environment",
            "id": "084e6df7-9165-46d2-9e1c-b87ccfc53d18"
        },
        {
            "environment_id": "5e70db57-7485-4ca9-bb4d-482416993ddd",
            "interval": "5m",
            "note": "Production Monitoring",
            "id": "c60e5a78-0dbd-493a-9e99-9a8282935d0c"
        }
    ],
    "error": null,
    "meta": {
        "status": "success"
    }
}

Create Schedule

Create a new test schedule.

Request

POST/buckets/<bucket_key>/tests/<test_id>/schedules

POST Body

The POST body must be a JSON object with the following parameters

Data Attributes
environment_id string required The id of the environment to use when running the test.
interval string required The schedule's interval, must be one of:
  • 1m — every minute
  • 5m — every 5 minutes
  • 15m — every 15 minutes
  • 30m — every 30 minutes
  • 1h — every hour
  • 6h — every 6 hours
  • 1d — every day
note string optional A human-friendly description for the schedule.
Sample POST Data
{
    "environment_id": "951b681e-0a16-44ab-acfb-505a0a8564e9",
    "interval": "1d",
    "note": "Once a day schedule"
}

Response

Returns the details of the new test schedule with a 201 CREATED status if the schedule is successfully created. See the Schedule Detail response.


Schedule Details

Request

GET/buckets/<bucket_key>/tests/<test_id>/schedules/<schedule_id>

Response

Returns the details of the test schedule.

Data Attributes
environment_id string required The id of the environment to use when running the test.
interval string required The schedule's interval (e.g. 1m, 5m, 15m, 30m, 1h, 6h, 1d).
note string optional A human-friendly description for the schedule.
Sample Response Data
{
    "data": {
            "environment_id": "1eeb3695-5d0f-467c-9d51-8b773dce29ba",
            "interval": "1h",
            "note": "Staging Environment",
            "id": "084e6df7-9165-46d2-9e1c-b87ccfc53d18"
    },
    "error": null,
    "meta": {
        "status": "success"
    }
}

Modify Schedule

Update the details of a single schedule by making a PUT request with a JSON body to the schedule details resource. Updating a schedule will cause the test to execute starting at the time of the request on the given interval.

Request

PUT/buckets/<bucket_key>/tests/<test_id>/schedules/<schedule_id>

PUT Body

The PUT body must be a JSON object with the following parameters

environment_id string required The id of the environment to use when running the test.
interval string required The schedule's interval, must be one of:
  • 1m — every minute
  • 5m — every 5 minutes
  • 15m — every 15 minutes
  • 30m — every 30 minutes
  • 1h — every hour
  • 6h — every 6 hours
  • 1d — every day
note string optional A human-friendly description for the schedule.

Sample PUT Request

{
    "environment_id": "1eeb3695-5d0f-467c-9d51-8b773dce29ba",
    "interval": "5m",
    "note": "Production Monitoring Schedule"
}

Response

Returns the updated details of the schedule.


Delete (Stop) Schedule

Delete a schedule.

Request

DELETE/buckets/<bucket_key>/tests/<test_id>/schedules/<schedule_id>

Response

Returns 204 NO CONTENT if the schedule is successfully deleted.