Headers

• kbn-xsrf string Required

  A required header to protect against CSRF attacks

Path parameters

• id string Required

  Identifier of the rule.

Responses

• 200 application/json

  Indicates a successful call.

  Hide response attribute Show response attribute object

  • body object Required

    Additional properties are NOT allowed.

    Hide body attribute Show body attribute object

    • schedule object Required

      Additional properties are NOT allowed.

      Hide schedule attributes Show schedule attributes object

      • custom object

        Additional properties are NOT allowed.

        Hide custom attributes Show custom attributes object

        • duration string Required

          The duration of the schedule. It allows values in <integer><unit> format. <unit> is one of d, h, m, or s for hours, minutes, seconds. For example: 1d, 5h, 30m, 5000s.

        • recurring object

          Additional properties are NOT allowed.

          Hide recurring attributes Show recurring attributes object

          • end string

            The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: 2025-04-01T00:00:00.000Z.

          • every string

            The interval and frequency of a recurring schedule. It allows values in <integer><unit> format. <unit> is one of d, w, M, or y for days, weeks, months, years. For example: 15d, 2w, 3m, 1y.

          • occurrences number

            The total number of recurrences of the schedule.

            Minimum value is 1.

          • onMonth array[number]

            The specific months for a recurring schedule. Valid values are 1-12.

            At least 1 element. Minimum value of each is 1, maximum value of each is 12.

          • onMonthDay array[number]

            The specific days of the month for a recurring schedule. Valid values are 1-31.

            At least 1 element. Minimum value of each is 1, maximum value of each is 31.

          • onWeekDay array[string]

            The specific days of the week ([MO,TU,WE,TH,FR,SA,SU]) or nth day of month ([+1MO, -3FR, +2WE, -4SA, -5SU]) for a recurring schedule.

            At least 1 element.

        • start string Required

          The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: 2025-03-12T12:00:00.000Z.

        • timezone string

          The timezone of the schedule. The default timezone is UTC.

      • id string Required

        Identifier of the snooze schedule.

• 400

  Indicates an invalid schema.

• 403

  Indicates that this call is forbidden.

• 404

  Indicates a rule with the given id does not exist.