--- title: "Create Scheduled Maintenance State" method: POST path: "/scheduled-maintenance-state" tags: ["Scheduled Maintenance State"] --- # Create Scheduled Maintenance State `POST /scheduled-maintenance-state` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/scheduled-maintenance-state` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new Scheduled Maintenance State ## Request body - object - `data` ScheduledMaintenanceStateCreateSchema, required: Create schema for ScheduledMaintenanceState model. Create - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [No access - you don't have permission for this operation] - `name` string, required: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `color` object, required: Color of this resource in Hex (#32a852 for example). Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isScheduledState` boolean: Is this state a scheduled state? Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isOngoingState` boolean: Is this state a ongoing state? Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isEndedState` boolean: Is this state a ended state? Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isResolvedState` boolean: Is this state a resolved state? Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `order` integer: Where this state sits in the project's list of scheduled maintenance states: 1 is the top. Events only ever move down the list, so the scheduled, ongoing, ended and completed states have to stay in that order. A new state without a number goes just above the completed state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isArchived` boolean: Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archived. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] ## Response `201` Created successfully - object - `data` ScheduledMaintenanceStateReadSchema: Read schema for ScheduledMaintenanceState model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [No access - you don't have permission for this operation] - `name` string, required: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `slug` string: Friendly globally unique name for your object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [No access - you don't have permission for this operation] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [No access - you don't have permission for this operation] - `color` object, required: Color of this resource in Hex (#32a852 for example). Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isScheduledState` boolean: Is this state a scheduled state? Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isOngoingState` boolean: Is this state a ongoing state? Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isEndedState` boolean: Is this state a ended state? Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isResolvedState` boolean: Is this state a resolved state? Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `order` integer: Where this state sits in the project's list of scheduled maintenance states: 1 is the top. Events only ever move down the list, so the scheduled, ongoing, ended and completed states have to stay in that order. A new state without a number goes just above the completed state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `isArchived` boolean: Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archived. Permissions - Create: [Project Owner, Project Admin, Scheduled Maintenance Admin, Create Scheduled Maintenance State], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [Project Owner, Project Admin, Scheduled Maintenance Admin, Edit Scheduled Maintenance State] - `archivedAt` object: When this scheduled maintenance state was archived. Empty while it is not archived. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [No access - you don't have permission for this operation] - `archivedByUserId` string, uuid: User ID who archived this object (if this object was archived by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance State], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)