Scheduled Maintenance Event

Manage scheduled maintenance event for your project

Permissions

Your API Token needs permissions to create, update, read or delete this resource. If you do not have permissions to make a request a 4xx status will be sent as response.

Read Permissions

You need one of these permissions to read Scheduled Maintenance Event:

  • Name
    ProjectOwner
    Type
    Project Owner
    Description

    Owner of this project. Manages billing, inviting other admins to this project, and can delete this project.

  • Name
    ProjectAdmin
    Type
    Project Admin
    Description

    Admin of this project. Manages team members in this project, however cannot manage billing or delete this project.

  • Name
    ProjectMember
    Type
    Project Member
    Description

    Member of this project. Can view most resources unless restricted.

  • Name
    CanReadProjectScheduledMaintenance
    Type
    Can Read Scheduled Maintenance
    Description

    This permission can read Scheduled Maintenance of this project.

Create Permissions

You need one of these permissions to create Scheduled Maintenance Event:

  • Name
    ProjectOwner
    Type
    Project Owner
    Description

    Owner of this project. Manages billing, inviting other admins to this project, and can delete this project.

  • Name
    ProjectAdmin
    Type
    Project Admin
    Description

    Admin of this project. Manages team members in this project, however cannot manage billing or delete this project.

  • Name
    ProjectMember
    Type
    Project Member
    Description

    Member of this project. Can view most resources unless restricted.

  • Name
    CanCreateProjectScheduledMaintenance
    Type
    Can Create Scheduled Maintenance
    Description

    This permission can create Scheduled Maintenance this project.

Update Permissions

You need one of these permissions to update Scheduled Maintenance Event:

  • Name
    ProjectOwner
    Type
    Project Owner
    Description

    Owner of this project. Manages billing, inviting other admins to this project, and can delete this project.

  • Name
    ProjectAdmin
    Type
    Project Admin
    Description

    Admin of this project. Manages team members in this project, however cannot manage billing or delete this project.

  • Name
    ProjectMember
    Type
    Project Member
    Description

    Member of this project. Can view most resources unless restricted.

  • Name
    CanEditProjectScheduledMaintenance
    Type
    Can Edit Scheduled Maintenance
    Description

    This permission can edit Scheduled Maintenance of this project.

Delete Permissions

You need one of these permissions to delete Scheduled Maintenance Event:

  • Name
    ProjectOwner
    Type
    Project Owner
    Description

    Owner of this project. Manages billing, inviting other admins to this project, and can delete this project.

  • Name
    ProjectAdmin
    Type
    Project Admin
    Description

    Admin of this project. Manages team members in this project, however cannot manage billing or delete this project.

  • Name
    ProjectMember
    Type
    Project Member
    Description

    Member of this project. Can view most resources unless restricted.

  • Name
    CanDeleteProjectScheduledMaintenance
    Type
    Can Delete Scheduled Maintenance
    Description

    This permission can delete Scheduled Maintenance of this project.

The Scheduled Maintenance Event model

Properties

  • Name
    _id
    Type
    Object ID
    Description

    ID of this object

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    createdAt
    Type
    Date
    Description

    Date and Time when the object was created.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    updatedAt
    Type
    Date
    Description

    Date and Time when the object was updated.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    project
    Type
    Entity
    Description

    Relation to Project Resource in which this object belongs

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    projectId
    Type
    Object ID (Required)
    Description

    ID of your OneUptime Project in which this object belongs

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    title
    Type
    Text (Required)
    Description

    Title of this scheduled event.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    description
    Type
    Markdown
    Description

    Description of this scheduled event that will show up on Status Page. This is in markdown.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    slug
    Type
    Slug (Required)
    Description

    Friendly globally unique name for your object

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    createdByUser
    Type
    Entity
    Description

    Relation to User who created this object (if this object was created by a User)

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    createdByUserId
    Type
    Object ID
    Description

    User ID who created this object (if this object was created by a User)

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    monitors
    Type
    Entity Array
    Description

    List of monitors attached to this event

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    statusPages
    Type
    Entity Array
    Description

    List of status pages to show this event on

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    labels
    Type
    Entity Array
    Description

    Relation to Labels Array where this object is categorized in.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    currentScheduledMaintenanceState
    Type
    Entity
    Description

    Relation to Scheduled Maintenance State. The state the event currently is in.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    currentScheduledMaintenanceStateId
    Type
    Object ID (Required)
    Description

    Scheduled Maintenance State ID. The state the event currently is in.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    changeMonitorStatusTo
    Type
    Entity
    Description

    Relation to Monitor Status Object. All monitors connected to this event will be changed to this status when the event is ongoing.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    changeMonitorStatusToId
    Type
    Object ID
    Description

    Relation to Monitor Status Object ID. All monitors connected to this incident will be changed to this status when the event is ongoing.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    startsAt
    Type
    Date (Required)
    Description

    When does this event start?

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    endsAt
    Type
    Date (Required)
    Description

    When does this event end?

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    isStatusPageSubscribersNotifiedOnEventScheduled
    Type
    Boolean
    Description

    Status Page Subscribers Notified On Event Scheduled

    Permissions to Create:  This property is autogenerated.
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    shouldStatusPageSubscribersBeNotifiedOnEventCreated
    Type
    Boolean
    Description

    Should subscribers be notified about this event creation?

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing
    Type
    Boolean
    Description

    Should subscribers be notified about this event event is changed to ongoing?

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded
    Type
    Boolean
    Description

    Should subscribers be notified about this event event is changed to ended?

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
  • Name
    customFields
    Type
    JSON
    Description

    Custom Fields on this resource.

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  ProjectOwner or ProjectAdmin or ProjectMember or CanEditProjectScheduledMaintenance
  • Name
    isOwnerNotifiedOfResourceCreation
    Type
    Boolean (Required)
    Description

    Are owners notified of when this resource is created?

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateProjectScheduledMaintenance
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadProjectScheduledMaintenance
    Permissions to Update:  This property cannot be updated.
GET or POST/api/scheduled-maintenance/get-list

List

This endpoint allows you to retrieve a paginated list of all your Scheduled Maintenance Event. By default, a maximum of ten Scheduled Maintenance Event are shown per page.

Optional Query Params

  • Limit
    limit
    Type
    number
    Description

    Number of objects to fetch. By default 10, you can increase this count up to 100

  • Skip
    skip
    Type
    number
    Description

    Number of objects to skip. This can be useful in pagination

Optional Request Body

  • Query
    query
    Type
    query
    Description

    If you would like to filter on Scheduled Maintenance Event. You can specify include a query here. For more information, please check out writing queries here.

  • Select
    select
    Type
    select
    Description

    By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

  • Sort
    sort
    Type
    sort
    Description

    Objects will be sorted based on created date by default. You can change the sort order by passing please check how to select here.

Example List Request

POST
/api/scheduled-maintenance/get-list?skip=0&limit=10 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body:

{
    "select": {
        // select object  (optional, if left optional it'll only fetch ID). 
    },
    "query": {
        // query object (optional, if left optional it'll select everything)
    },
    "sort": {
        // sort object (optional)
    }
}

Example List Response

{
    "count": 10,
    "limit": 10,
    "skip": 0,
    "data": [
        {
            "_id": "p39d997a-026c-44b2-8b02-7b2814d886d2",
            // ...
        },
        {
            "_id": "l34e743e-1af5-4b0a-998f-1d421c22f7a1",
            // ...
        },
        {
            "_id": "6a5aa129-0b3e-45b7-a7f6-b4b6df338a19",
            // ...
        }
    ]
}
GET or POST/api/scheduled-maintenance/:id/get-item

Get item by ID

This endpoint allows you to retrieve Scheduled Maintenance Event by ID.

Required Query Params

  • ID
    id
    Type
    text
    Description

    ID of the Object

Optional Request Body

  • Select
    select
    Type
    select
    Description

    By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

Example Item Request

POST
/api/scheduled-maintenance/3599ee69-43a7-42d7/get-item 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body: 

{
    "select": {
        // select object  (optional, if left optional it'll only fetch ID). 
    },
}

Example Item Response

{
    "_id": "3599ee69-43a7-42d7",
    // ... other object fields.
}
POST/api/scheduled-maintenance/count

Count

This endpoint allows you to retrieve the count of all your Scheduled Maintenance Event.

Optional Request Body

  • Query
    query
    Type
    query
    Description

    If you would like to filter on Scheduled Maintenance Event. You can specify include a query here. For more information, please check out writing queries here.

Example Count Request

POST
/api/scheduled-maintenance/count 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body:

{
    "query": {
        // query object (optional, if left optional it'll select everything)
    },
}

Example Count Response

{
    "count": 107
}
POST/api/scheduled-maintenance

Create Scheduled Maintenance Event

This endpoint allows you to create a new object.

Request Body

  • Data
    data
    Type
    JSON
    Description

    Object to update as JSON

Example Create Request

POST
/api/scheduled-maintenance 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body:

{
    "data": {
        // properties to update as JSON.
    }
}

Example Create Response

{
    "_id": "xxx-xxx-xxxx-xxxx",
    // other object fields.
}
PUT/api/scheduled-maintenance/:id

Update by ID

This endpoint allows you to update object by its ID.

Request Body

  • Data
    data
    Type
    JSON
    Description

    Object to update as JSON

Example Update Request

PUT
/api/scheduled-maintenance/3599ee69-43a7-42d7 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body:

{
    "data": {
        // properties to update as JSON.
    }
}

Example Update Response

{}
DELETE/api/scheduled-maintenance/:id

Delete by ID

This endpoint allows you to delete object by its ID.

Example Delete Request

DELETE
/api/scheduled-maintenance/3599ee69-43a7-42d7 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Example Delete Response

{}