--- title: "Create Alert State" method: POST path: "/alert-state" tags: ["Alert State"] --- # Create Alert State `POST /alert-state` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/alert-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 Alert State ## Request body - object - `data` AlertStateCreateSchema, required: Create schema for AlertState model. Create - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `color` object, required: Color of this resource in Hex (#32a852 for example). Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `isCreatedState` boolean: Is it the created state of the alert? Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `isAcknowledgedState` boolean: Is it the acknowledged state of the alert? Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `isResolvedState` boolean: Is it the resolved state of the alert? Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `order` integer: Where this state sits in the project's list of alert states: 1 is the top. Alerts only ever move down the list, and an alert in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved 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, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `isArchived` boolean: Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] ## Response `201` Created successfully - object - `data` AlertStateReadSchema: Read schema for AlertState model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert 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, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `isCreatedState` boolean: Is it the created state of the alert? Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `isAcknowledgedState` boolean: Is it the acknowledged state of the alert? Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `isResolvedState` boolean: Is it the resolved state of the alert? Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `order` integer: Where this state sits in the project's list of alert states: 1 is the top. Alerts only ever move down the list, and an alert in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved 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, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `isArchived` boolean: Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived. Permissions - Create: [Project Owner, Project Admin, Alert Admin, Create Alert State], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert State], Update: [Project Owner, Project Admin, Alert Admin, Edit Alert State] - `archivedAt` object: When this alert 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, Alert Admin, Alert Member, Alert Viewer, Read Alert 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, Alert Admin, Alert Member, Alert Viewer, Read Alert 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)