Skip to main content

​
Overview

Create a new public incident on your status page to inform users about service issues, maintenance windows, or degraded performance. Incidents are visible to all status page viewers and can include multiple affected components.

​
Authentication

All requests must include authentication via API Key:
  • API Key: X-API-Key: YOUR_API_KEY

​
Request

curl -X POST https://api.uptimeio.com/api/projects/660e8400-e29b-41d4-a716-446655440001/status-pages/550e8400-e29b-41d4-a716-446655440000/incidents \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "title": "API Service Degradation",
    "message": "We are experiencing elevated response times on our API servers",
    "severity": "major",
    "status": "investigating",
    "affected_monitor_ids": [
      "770e8400-e29b-41d4-a716-446655440010",
      "770e8400-e29b-41d4-a716-446655440011"
    ]
  }'

​
Path Parameters

ParameterTypeDescription
projectIdUUIDThe ID of the project
statusPageIdUUIDThe ID of the status page

​
Request Body

FieldTypeRequiredDescription
titlestringYesIncident title (1-200 characters)
messagestringYesDetailed incident message (1-5000 characters)
severitystringYesSeverity level: minor, major, critical
statusstringNoInitial status: investigating, identified, monitoring, resolved (default: investigating)
affected_monitor_idsUUID[]YesArray of monitor IDs affected by this incident (min 1)

​
Severity Levels

  • minor: Minor issue with minimal impact on users
  • major: Significant issue affecting multiple services or users
  • critical: Critical outage affecting all or most services

​
Status Values

  • investigating: Issue is under investigation
  • identified: Root cause has been identified
  • monitoring: Fix has been applied, monitoring for resolution
  • resolved: Issue has been resolved

​
Response

Returns the created incident object with a 201 status code. 
{
  "success": true,
  "data": {
    "incident": {
      "id": "990e8400-e29b-41d4-a716-446655440050",
      "status_page_id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "API Service Degradation",
      "message": "We are experiencing elevated response times on our API servers",
      "severity": "major",
      "status": "investigating",
      "affected_monitor_ids": [
        "770e8400-e29b-41d4-a716-446655440010",
        "770e8400-e29b-41d4-a716-446655440011"
      ],
      "created_at": "2024-12-26T11:00:00Z",
      "updated_at": "2024-12-26T11:00:00Z",
      "resolved_at": null,
      "updates": []
    }
  }
}

​
Response Fields

FieldTypeDescription
idUUIDUnique incident identifier
status_page_idUUIDStatus page ID
titlestringIncident title
messagestringIncident description
severitystringSeverity level
statusstringCurrent status
affected_monitor_idsUUID[]List of affected monitor IDs
created_attimestampCreation timestamp
updated_attimestampLast update timestamp
resolved_attimestamp | nullResolution timestamp if resolved
updatesarrayArray of incident updates

​
Status Codes

StatusDescription
201Incident created successfully
400Validation error (invalid data or monitors)
401Unauthorized (missing or invalid token)
403Forbidden (no permission to manage status page)
404Status page not found

​
Examples

​
Create Minor Incident

curl -X POST https://api.uptimeio.com/api/projects/660e8400-e29b-41d4-a716-446655440001/status-pages/550e8400-e29b-41d4-a716-446655440000/incidents \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Scheduled Maintenance",
    "message": "We will be performing scheduled maintenance on our DNS servers",
    "severity": "minor",
    "status": "monitoring",
    "affected_monitor_ids": ["770e8400-e29b-41d4-a716-446655440012"]
  }'

​
Create Critical Incident

curl -X POST https://api.uptimeio.com/api/projects/660e8400-e29b-41d4-a716-446655440001/status-pages/550e8400-e29b-41d4-a716-446655440000/incidents \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Complete Service Outage",
    "message": "All services are currently offline. Our team is working to restore service as quickly as possible.",
    "severity": "critical",
    "status": "investigating",
    "affected_monitor_ids": [
      "770e8400-e29b-41d4-a716-446655440010",
      "770e8400-e29b-41d4-a716-446655440011",
      "770e8400-e29b-41d4-a716-446655440012"
    ]
  }'

​
Error Codes

​
Validation Error - Missing Required Field

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed: title: String must contain at least 1 character(s)"
  }
}

​
Invalid Monitor IDs

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid monitor IDs: 770e8400-e29b-41d4-a716-446655440099 - monitors must belong to this status page"
  }
}

​
Status Page Not Found

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Status page not found"
  }
}

​
Access Denied

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Access denied"
  }
}