Components API

Create and list components for an organization. All endpoints require session authentication.

GET /v1/organizations/{orgID}/components

List all components for an organization.

ParameterTypeRequiredDescription
orgIDstringYesOrganization ID (URL parameter)
Response (200 OK)
[
  {
    "id": "a1b2c3d4e5f6...",
    "organization_id": "org_id_here",
    "name": "API Server",
    "description": "Main REST API",
    "status": "operational",
    "position": 0,
    "created_at": "2026-02-20T10:30:00Z",
    "updated_at": "2026-02-20T10:30:00Z"
  }
]
POST /v1/organizations/{orgID}/components

Create a new component. Status defaults to 'operational'.

ParameterTypeRequiredDescription
orgIDstringYesOrganization ID (URL parameter)
namestringYesComponent name
descriptionstringNoComponent description
Request
curl -X POST https://api.pingpage.live/v1/organizations/{'{orgID}'}/components \
  -H "Content-Type: application/json" \
  -b "session_token=your_token" \
  -d '{
    "name": "API Server",
    "description": "Main REST API"
  }'
Response (201 Created)
{
  "id": "a1b2c3d4e5f6...",
  "organization_id": "org_id_here",
  "name": "API Server",
  "description": "Main REST API",
  "status": "operational",
  "position": 0,
  "created_at": "2026-02-20T10:30:00Z",
  "updated_at": "2026-02-20T10:30:00Z"
}

Component Status Values

  • operational — component is working normally
  • degraded_performance — working but impaired
  • partial_outage — some functionality unavailable
  • major_outage — completely down