@akamai/openapi-ts
    Preparing search index...

    Type Alias GetMaintenance200Writable

    type GetMaintenance200Writable = {
        data?: {
            complete_time?: string;
            description?: "Scheduled Maintenance" | "Emergency Maintenance";
            entity?: { id?: number; label?: string; type?: string; url?: string };
            maintenance_policy_set?: string;
            not_before?: string;
            reason?: string;
            source?: "platform" | "user";
            start_time?: string;
            status?:
                | "pending"
                | "scheduled"
                | "started"
                | "in-progress"
                | "completed"
                | "canceled";
            type?: | "reboot"
            | "cold_migration"
            | "live_migration"
            | "migrate"
            | "power_off_on";
            when?: string;
        }[];
    }
    Index

    Properties

    data?

    Properties

    data?: {
        complete_time?: string;
        description?: "Scheduled Maintenance" | "Emergency Maintenance";
        entity?: { id?: number; label?: string; type?: string; url?: string };
        maintenance_policy_set?: string;
        not_before?: string;
        reason?: string;
        source?: "platform" | "user";
        start_time?: string;
        status?:
            | "pending"
            | "scheduled"
            | "started"
            | "in-progress"
            | "completed"
            | "canceled";
        type?: | "reboot"
        | "cold_migration"
        | "live_migration"
        | "migrate"
        | "power_off_on";
        when?: string;
    }[]

    Type Declaration

    • Optionalcomplete_time?: string

      Beta, Filterable The time the maintenance completed. This field is filterable based on these parameters:

      • A single ISO 8601 timestamp (yyyy-mm-ddThh:mm:ss), which returns only matches for that value.

      • Pairs of operator string keys (+or, +gt, +gte, +lt, +lte, or +neq) and single ISO 8601 timestamp. The +or operator accepts an array of values that can consist of single date-time strings or dictionaries of inequality operator pairs.

    • Optionaldescription?: "Scheduled Maintenance" | "Emergency Maintenance"

      Beta Differentiates between scheduled and emergency maintenance.

    • Optionalentity?: { id?: number; label?: string; type?: string; url?: string }

      The entity affected by the maintenance.

      • Optionalid?: number

        The unique identifier of the entity targeted by the maintenance.

      • Optionallabel?: string

        The name of the entity targeted by the maintenance.

      • Optionaltype?: string

        The type of entity.

      • Optionalurl?: string

        A combination of the API operation prefix and the entity's id that can be used to review the entity.

    • Optionalmaintenance_policy_set?: string

      Beta, Filterable The maintenance policy configured by the user.

    • Optionalnot_before?: string

      Beta, Filterable The earliest time when the maintenance can start. This field is filterable based on these parameters:

      • A single ISO 8601 timestamp (yyyy-mm-ddThh:mm:ss), which returns only matches for that value.

      • Pairs of operator string keys (+or, +gt, +gte, +lt, +lte, or +neq) and single ISO 8601 timestamp. The +or operator accepts an array of values that can consist of single date-time strings or dictionaries of inequality operator pairs.

    • Optionalreason?: string

      The reason maintenance is being performed.

    • Optionalsource?: "platform" | "user"

      Beta The origin of the maintenance. A platform source indicates that the maintenance was initiated by Akamai. A user source indicates that the maintenance was initiated by the user.

    • Optionalstart_time?: string

      Beta, Filterable The time the maintenance started. This field is filterable based on these parameters:

      • A single ISO 8601 timestamp (yyyy-mm-ddThh:mm:ss), which returns only matches for that value.

      • Pairs of operator string keys (+or, +gt, +gte, +lt, +lte, or +neq) and single ISO 8601 timestamp. The +or operator accepts an array of values that can consist of single date-time strings or dictionaries of inequality operator pairs.

    • Optionalstatus?: "pending" | "scheduled" | "started" | "in-progress" | "completed" | "canceled"

      Filterable The maintenance status. Maintenance progress follows the sequence pending, scheduled, started, and completed. A scheduled status is unique to Linodes that require a reboot for QEMU maintenance.

    • Optionaltype?: "reboot" | "cold_migration" | "live_migration" | "migrate" | "power_off_on"

      Filterable The type of maintenance.

    • Optionalwhen?: string

      Filterable The start time for the maintenance. This field is filterable based on these parameters:

      • A single ISO 8601 timestamp (yyyy-mm-ddThh:mm:ss), which returns only matches for that value.

      • Pairs of operator string keys (+or, +gt, +gte, +lt, +lte, or +neq) and single ISO 8601 timestamp. The +or operator accepts an array of values that can consist of single date-time strings or dictionaries of inequality operator pairs.

    Settings

    Member Visibility

    On This Page

    Properties