v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Synthetics

Create a Synthetics downtime

Create a new Synthetics downtime.

post/api/v2/synthetics/downtimes

Request body

Example request

{
  "data": {
    "attributes": {
      "isEnabled": true,
      "name": "Weekly maintenance",
      "testIds": [
        "abc-def-123"
      ],
      "timeSlots": [
        {
          "duration": 3600,
          "start": {
            "day": 15,
            "hour": 10,
            "minute": 30,
            "month": 1,
            "year": 2024
          },
          "timezone": "Europe/Paris"
        }
      ]
    },
    "type": "downtime"
  }
}

Response

Created

Example response

{
  "data": {
    "attributes": {
      "createdAt": "2024-01-15T10:30:00Z",
      "createdBy": "00000000-0000-0000-0000-000000000003",
      "createdByName": "Jane Doe",
      "description": "Scheduled weekly maintenance window.",
      "isEnabled": true,
      "name": "Weekly maintenance",
      "tags": [
        "team:backend",
        "env:prod"
      ],
      "testIds": [
        "abc-def-123",
        "xyz-uvw-456"
      ],
      "timeSlots": [
        {
          "duration": 3600,
          "id": "00000000-0000-0000-0000-000000000002",
          "start": {
            "day": 15,
            "hour": 10,
            "minute": 30,
            "month": 1,
            "year": 2024
          },
          "timezone": "Europe/Paris"
        }
      ],
      "updatedAt": "2024-01-15T10:30:00Z",
      "updatedBy": "00000000-0000-0000-0000-000000000003",
      "updatedByName": "Jane Doe"
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "downtime"
  }
}