Projects: Create

This documentation entry provides a clear guide for developers on how to create a new project using the API, including the necessary parameters, headers, and expected response.

Endpoint

POST /api/projects

Create a new project with the specified parameters.

Request

HTTP Request

POST https://uptimekeep.com/api/projects

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.
Content-Type	String	Must be set to multipart/form-data for file uploads.

Parameters

Parameter	Type	Required	Description
name	String	Yes	Name of the project.
color	String	No	Color associated with the project (hex code).

Example of a request:

curl --request POST \
--url 'https://uptimekeep.com/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Production' \
--form 'color=#ffffff'

Response

A successful response returns a JSON object containing the unique identifier of the newly created project.

Response Example

{
    "data": {
        "id": 1
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the new project.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 400 Bad Request if required parameters are missing or invalid.