--- title: "Create Status Page Header Link" method: POST path: "/status-page-header-link" tags: ["Status Page Header Link"] --- # Create Status Page Header Link `POST /status-page-header-link` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/status-page-header-link` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new Status Page Header Link ## Request body - object - `data` StatusPageHeaderLinkCreateSchema, required: Create schema for StatusPageHeaderLink model. Create - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [No access - you don't have permission for this operation] - `statusPageId` string, uuid, required: ID of your Status Page resource where this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [No access - you don't have permission for this operation] - `title` string, required: Title of this resource. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] - `link` string, required: URL to a website or any other resource on the internet. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] - `order` number: Where this link appears among the status page's header links, lowest number first. A new link is added to the end of the list. Setting a number another one already has puts it in that place, and the ones in the way move one place along to make room. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] ## Response `201` Created successfully - object - `data` StatusPageHeaderLinkReadSchema: Read schema for StatusPageHeaderLink model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [No access - you don't have permission for this operation] - `statusPageId` string, uuid, required: ID of your Status Page resource where this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [No access - you don't have permission for this operation] - `title` string, required: Title of this resource. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] - `link` string, required: URL to a website or any other resource on the internet. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] - `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, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [No access - you don't have permission for this operation] - `order` number: Where this link appears among the status page's header links, lowest number first. A new link is added to the end of the list. Setting a number another one already has puts it in that place, and the ones in the way move one place along to make room. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Create Header Link], Read: [Project Owner, Project Admin, Project Member, Viewer, Status Page Admin, Status Page Member, Status Page Viewer, Read Header Link], Update: [Project Owner, Project Admin, Project Member, Status Page Admin, Status Page Member, Edit Header Link] ## 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)