Status

Endpointhttps://api.neuratel.ai

System status and health. Monitor service health, uptime, and scheduled maintenance.

Get Public Status

GET

https://api.neuratel.ai

/v1/status/public

Public endpoint - returns full status page data No authentication required

Get Public Status › Responses

200

Successful Response

overall_status

string · required

uptime_30d

number · required

avg_response_time_ms

number · required

active_incidents_count

integer · required

object[] · required

Report Incident

POST

https://api.neuratel.ai

/v1/status/report-incident

Allow confirmed subscribers to report incidents using templates.

Report Incident › Request Body

email

string · email · required

template_id

string · required

affected_component_ids

string[]

Report Incident › Responses

Successful Response

No data returned

Run Health Checks

GET

https://api.neuratel.ai

/v1/status/health-check

Run real-time health checks on all services. Returns current status of each service. Names MUST match database component names exactly for latency updates.

Run Health Checks › Responses

200

Successful Response

object[]

name

string · required

status

string · required

required

last_checked

string · date-time · required

Get Admin Metrics

GET

https://api.neuratel.ai

/v1/status/admin/metrics

Get dashboard metrics for admin view

Get Admin Metrics › Responses

200

Successful Response

No data returned

List Subscribers

GET

https://api.neuratel.ai

/v1/status/admin/subscribers

List all subscribers (admin view)

List Subscribers › Responses

200

Successful Response

No data returned

Get Audit Log

GET

https://api.neuratel.ai

/v1/status/admin/audit

Get recent status notification audit log entries.

Get Audit Log › query Parameters

limit

integer · min: 1 · max: 500

Maximum number of log entries to return.

Default: 100

Get Audit Log › Responses

Successful Response

No data returned

List Components

GET

https://api.neuratel.ai

/v1/status/admin/components

List all components (admin view)

List Components › Responses

200

Successful Response

object[]

Admin view of component - no history needed

id

string · uuid · required

name

string · required

required

group_name

string · required

status

string · required

required

uptime_percentage

number · required

display_order

integer

Default: 0

is_visible

boolean

Default: true

Create Component

POST

https://api.neuratel.ai

/v1/status/admin/components

Create a new status component

Create Component › Request Body

name

string · required

group_name

string

Default: Core Services

display_order

integer

Default: 0

health_check_type

string

Default: http

health_check_interval

integer

Default: 60

Create Component › Responses

Successful Response

Admin view of component - no history needed

id

string · uuid · required

name

string · required

required

group_name

string · required

status

string · required

required

uptime_percentage

number · required

display_order

integer

Default: 0

is_visible

boolean

Default: true

POST/v1/status/admin/components

curl --request POST \
  --url https://api.neuratel.ai/v1/status/admin/components \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "string",
  "group_name": "Core Services",
  "display_order": 0,
  "status_url": "string",
  "health_check_url": "string",
  "health_check_type": "http",
  "health_check_interval": 60
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "string",
  "group_name": "Core Services",
  "display_order": 0,
  "status_url": "string",
  "health_check_url": "string",
  "health_check_type": "http",
  "health_check_interval": 60
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "string",
  "group_name": "group_name",
  "status": "status",
  "last_response_time_ms": 0,
  "uptime_percentage": 0,
  "status_url": "string",
  "health_check_url": "string",
  "health_check_type": "string",
  "health_check_interval": 0,
  "display_order": 0,
  "is_visible": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete Component

DELETE

https://api.neuratel.ai

/v1/status/admin/components/{component_id}

Delete a component

Delete Component › path Parameters

component_id

string · uuid · required

Delete Component › Responses

Successful Response

No data returned

Update Component

PATCH

https://api.neuratel.ai

/v1/status/admin/components/{component_id}

Update a component

Update Component › path Parameters

component_id

string · uuid · required

Update Component › Request Body

Update Component › Responses

Successful Response

No data returned

PATCH/v1/status/admin/components/{component_id}

curl --request PATCH \
  --url https://api.neuratel.ai/v1/status/admin/components/:component_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "description": "string",
  "group_name": "string",
  "status": "string",
  "display_order": 0,
  "status_url": "string",
  "health_check_url": "string",
  "health_check_type": "string",
  "health_check_interval": 0,
  "is_visible": true
}
'

shell

Example Request Body

{
  "name": "string",
  "description": "string",
  "group_name": "string",
  "status": "string",
  "display_order": 0,
  "status_url": "string",
  "health_check_url": "string",
  "health_check_type": "string",
  "health_check_interval": 0,
  "is_visible": true
}

json

Example Responses

{}

json

application/json

Update Component Status

PATCH

https://api.neuratel.ai

/v1/status/admin/components/{component_id}/status

Update only the status of a component (quick status change)

Update Component Status › path Parameters

component_id

string · uuid · required

Update Component Status › Request Body

Request body for updating component status only

status

string · required

Update Component Status › Responses

Successful Response

No data returned

List Incidents

GET

https://api.neuratel.ai

/v1/status/admin/incidents

List all incidents (optionally filtered by status)

List Incidents › query Parameters

status

Filter by incident status: investigating, identified, monitoring, resolved.

limit

integer · max: 100

Maximum number of incidents to return. Defaults to 20. Max 100.

Default: 20

List Incidents › Responses

Successful Response

object[]

id

string · uuid · required

title

string · required

status

string · required

impact

string · required

started_at

string · date-time · required

required

object[] · required

affected_components

string[] · required

Create Incident

POST

https://api.neuratel.ai

/v1/status/admin/incidents

Create a new incident

Create Incident › Request Body

title

string · required

message

string · required

impact

string

Default: minor

affected_component_ids

string[]

Default: []

component_status

string

Default: degraded

Create Incident › Responses

Successful Response

id

string · uuid · required

title

string · required

status

string · required

impact

string · required

started_at

string · date-time · required

required

object[] · required

affected_components

string[] · required

POST/v1/status/admin/incidents

curl --request POST \
  --url https://api.neuratel.ai/v1/status/admin/incidents \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "title",
  "impact": "minor",
  "message": "message",
  "affected_component_ids": [],
  "component_status": "degraded"
}
'

shell

Example Request Body

{
  "title": "title",
  "impact": "minor",
  "message": "message",
  "affected_component_ids": [],
  "component_status": "degraded"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "title",
  "status": "status",
  "impact": "impact",
  "started_at": "2024-08-25T15:00:00Z",
  "resolved_at": "2024-08-25T15:00:00Z",
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "status",
      "message": "message",
      "created_by": "string",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    "string"
  ]
}

json

application/json

Send Status Announcement

POST

https://api.neuratel.ai

/v1/status/admin/announce

Send a status announcement to subscribers (email + Slack + in-app).

Send Status Announcement › Request Body

Request body for status announcements

subject

string · required

message

string · required

component_ids

string[]

Send Status Announcement › Responses

Successful Response

No data returned

Add Incident Update

POST

https://api.neuratel.ai

/v1/status/admin/incidents/{incident_id}/updates

Add an update to an incident

Add Incident Update › path Parameters

incident_id

string · uuid · required

Add Incident Update › Request Body

status

string · required

message

string · required

Add Incident Update › Responses

Successful Response

No data returned

Delete Incident

DELETE

https://api.neuratel.ai

/v1/status/admin/incidents/{incident_id}

Delete an incident

Delete Incident › path Parameters

incident_id

string · uuid · required

Delete Incident › Responses

Successful Response

No data returned

List Maintenance

GET

https://api.neuratel.ai

/v1/status/admin/maintenance

List all scheduled maintenance

List Maintenance › Responses

200

Successful Response

object[]

id

string · uuid · required

title

string · required

required

scheduled_start

string · date-time · required

scheduled_end

string · date-time · required

is_active

boolean · required

is_completed

boolean · required

affected_components

string[] · required

affected_component_ids

string[]

Create Maintenance

POST

https://api.neuratel.ai

/v1/status/admin/maintenance

Schedule maintenance

Create Maintenance › Request Body

Request body for creating maintenance

title

string · required

scheduled_start

string · date-time · required

scheduled_end

string · date-time · required

affected_components

string[]

Create Maintenance › Responses

Successful Response

No data returned

Delete Maintenance

DELETE

https://api.neuratel.ai

/v1/status/admin/maintenance/{maintenance_id}

Delete a scheduled maintenance window

Delete Maintenance › path Parameters

maintenance_id

string · uuid · required

Delete Maintenance › Responses

Successful Response

No data returned

Update Maintenance

PATCH

https://api.neuratel.ai

/v1/status/admin/maintenance/{maintenance_id}

Update or reschedule maintenance

Update Maintenance › path Parameters

maintenance_id

string · uuid · required

Update Maintenance › Request Body

Request body for updating maintenance

Update Maintenance › Responses

Successful Response

No data returned

Start Maintenance

POST

https://api.neuratel.ai

/v1/status/admin/maintenance/{maintenance_id}/start

Mark maintenance as started

Start Maintenance › path Parameters

maintenance_id

string · uuid · required

Start Maintenance › Responses

Successful Response

No data returned

Complete Maintenance

POST

https://api.neuratel.ai

/v1/status/admin/maintenance/{maintenance_id}/complete

Mark maintenance as completed

Complete Maintenance › path Parameters

maintenance_id

string · uuid · required

Complete Maintenance › Responses

Successful Response

No data returned

POST

https://api.neuratel.ai

/v1/status/subscribe

Subscribe email to status updates (requires email confirmation)

Email subscription request

email

string · email · required

notify_on

string[]

Successful Response

No data returned

POST

https://api.neuratel.ai

/v1/status/subscribe/slack

Subscribe a Slack channel to status updates via webhook.

How to get your webhook URL:

Go to https://api.slack.com/apps
Create a new app (or select existing) → "From scratch"
Go to "Incoming Webhooks" → Enable
Click "Add New Webhook to Workspace"
Select the channel where you want notifications
Copy the webhook URL and paste it here

Your channel will receive rich formatted notifications whenever:

New incidents are created
Incidents are updated or resolved
Maintenance is scheduled, started, or completed

Slack webhook subscription request

webhook_url

string · required

Slack Incoming Webhook URL

Channel name for display (e.g. #status-alerts)

notify_on

string[]

Successful Response

No data returned

Unsubscribe Slack Webhook

DELETE

https://api.neuratel.ai

/v1/status/subscribe/slack

Unsubscribe a Slack channel from status updates

Unsubscribe Slack Webhook › query Parameters

webhook_url

string · required

Slack webhook URL to unsubscribe

Unsubscribe Slack Webhook › Responses

Successful Response

No data returned

Notifications Webhooks

Status

Get Public Status

Get Public Status › Responses

Report Incident

Report Incident › Request Body

Report Incident › Responses

Run Health Checks

Run Health Checks › Responses

Get Admin Metrics

Get Admin Metrics › Responses

List Subscribers

List Subscribers › Responses

Get Audit Log

Get Audit Log › query Parameters

Get Audit Log › Responses

List Components

List Components › Responses

Create Component

Create Component › Request Body

Create Component › Responses

Delete Component

Delete Component › path Parameters

Delete Component › Responses

Update Component

Update Component › path Parameters

Update Component › Request Body

Update Component › Responses

Update Component Status

Update Component Status › path Parameters

Update Component Status › Request Body

Update Component Status › Responses

List Incidents

List Incidents › query Parameters

List Incidents › Responses

Create Incident

Create Incident › Request Body

Create Incident › Responses

Send Status Announcement

Send Status Announcement › Request Body

Send Status Announcement › Responses

Add Incident Update

Add Incident Update › path Parameters

Add Incident Update › Request Body

Add Incident Update › Responses

Delete Incident

Delete Incident › path Parameters

Delete Incident › Responses

List Maintenance

List Maintenance › Responses

Create Maintenance

Create Maintenance › Request Body

Create Maintenance › Responses

Delete Maintenance

Delete Maintenance › path Parameters

Delete Maintenance › Responses

Update Maintenance

Update Maintenance › path Parameters

Update Maintenance › Request Body

Update Maintenance › Responses

Start Maintenance

Start Maintenance › path Parameters

Start Maintenance › Responses

Complete Maintenance

Complete Maintenance › path Parameters

Complete Maintenance › Responses

Subscribe To Updates

Subscribe To Updates › Request Body

Subscribe To Updates › Responses

Subscribe Slack Webhook

Subscribe Slack Webhook › Request Body

Subscribe Slack Webhook › Responses

Unsubscribe Slack Webhook

Unsubscribe Slack Webhook › query Parameters

Unsubscribe Slack Webhook › Responses