Skip to content

PATCH /projects/{project}

PATCH /api/v1/projects/{project}

Applies a partial update to a stored project.

ParameterTypeRequiredDescription
projectstringYesProject name
FieldTypeRequiredDescription
labelstring or nullNoUpdated label
descriptionstring or nullNoUpdated description
statusstring or nullNoenabled or disabled
Terminal window
curl -X PATCH http://localhost/api/v1/projects/status-page \
-H "Content-Type: application/json" \
-H "X-Uplinkr-Api-Key: replace-me-with-a-long-random-key" \
-d '{
"label": "Updated Status Page",
"description": "Updated description",
"status": "disabled"
}'
{
"data": {
"project": "status-page"
}
}
  • 200 Project updated
  • 401 Missing or invalid API key
  • 404 Project not found
  • 422 Validation failed