RapidAPI · Schema

ScheduleInput

API MarketplaceAPI ManagementAPI TestingAPI GatewayAPI DesignEnterprise

Properties

Name Type Description
testId string The test to run on this schedule
frequency string How often the test should run
environmentId string The environment to use for scheduled runs
locationIds array Monitoring locations to run the test from
enabled boolean Whether the schedule should be active
View JSON Schema on GitHub

JSON Schema

rapidapi-scheduleinput-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScheduleInput",
  "title": "ScheduleInput",
  "type": "object",
  "required": [
    "testId",
    "frequency",
    "locationIds"
  ],
  "properties": {
    "testId": {
      "type": "string",
      "description": "The test to run on this schedule"
    },
    "frequency": {
      "type": "string",
      "enum": [
        "5m",
        "15m",
        "30m",
        "1h",
        "6h",
        "12h",
        "24h"
      ],
      "description": "How often the test should run"
    },
    "environmentId": {
      "type": "string",
      "description": "The environment to use for scheduled runs"
    },
    "locationIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Monitoring locations to run the test from"
    },
    "enabled": {
      "type": "boolean",
      "default": true,
      "description": "Whether the schedule should be active"
    }
  }
}