# Pinghome API Documentation

This is the complete API documentation for connecting to the Pinghome API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Pinghome connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/pinghome/actions/{actionSlug}/run
```

## Pinghome actions

- PUT `change-uptime-monitor-status` Change Uptime Monitor Status
- GET `check-service-health-status` Check Service Health Status
- POST `create-incident` Create Incident
- POST `create-oncall-schedule` Create Oncall Schedule
- POST `create-personal-notification-channel` Create Personal Notification Channel
- POST `create-ruleset` Create Ruleset
- POST `create-service` Create Service
- POST `create-statuspage` Create Statuspage
- POST `create-subscription-for-statuspages` Create Subscription For Statuspages
- POST `create-team` Create Team
- POST `create-team-notification-channel` Create Team Notification Channel
- POST `create-uptime-monitor` Create Uptime Monitor
- POST `create-webhook` Create Webhook
- DELETE `delete-oncall-schedule` Delete Oncall Schedule
- DELETE `delete-personal-notification-channel` Delete Personal Notification Channel
- DELETE `delete-ruleset` Delete Ruleset
- DELETE `delete-single-heartbeat-monitor` Delete Single Heartbeat Monitor
- DELETE `delete-statuspage` Delete Statuspage
- DELETE `delete-statuspage-subscription` Delete Statuspage Subscription
- DELETE `delete-subscription` Delete Subscription
- DELETE `delete-team` Delete Team
- DELETE `delete-uptime-monitor` Delete Uptime Monitor
- GET `get-account-payment-method-information` Get Account Payment Method Information
- GET `get-comprehensive-statuspage-details` Get Comprehensive Statuspage Details
- GET `get-customer-profile` Get Customer Profile
- GET `get-domain-cname-settings` Get Domain Cname Settings
- GET `get-organisation-usage` Get Organisation Usage
- GET `get-plan-limits-by-version` Get Plan Limits By Version
- GET `get-service-details` Get Service Details
- GET `get-specific-heartbeat-information` Get Specific Heartbeat Information
- GET `get-specific-uptime-monitor` Get Specific Uptime Monitor
- GET `get-statistics-for-statuspage-component` Get Statistics For Statuspage Component
- GET `get-statuspage` Get Statuspage
- GET `get-subscription-payment-history` Get Subscription Payment History
- GET `get-subscription-proration-details` Get Subscription Proration Details
- GET `list-customer-schedules` List Customer Schedules
- GET `list-incident-actions` List Incident Actions
- GET `list-personal-notification-channels` List Personal Notification Channels
- GET `list-ruleset-actions` List Ruleset Actions
- GET `list-rulesets` List Rulesets
- GET `list-service-heartbeats` List Service Heartbeats
- GET `list-statuspage-components` List Statuspage Components
- GET `list-statuspage-subscriptions` List Statuspage Subscriptions
- GET `list-statuspages-for-organisation` List Statuspages For Organisation
- GET `list-team-incidents` List Team Incidents
- GET `list-team-members` List Team Members
- GET `list-team-notification-channels` List Team Notification Channels
- GET `list-teams` List Teams
- GET `list-uptime-monitor-regions` List Uptime Monitor Regions
- GET `list-webhook-events` List Webhook Events
- GET `list-webhooks` List Webhooks
- POST `setup-heartbeat-monitor` Setup Heartbeat Monitor
- PUT `update-customer-information` Update Customer Information
- PUT `update-heartbeat-monitor` Update Heartbeat Monitor
- PUT `update-incident` Update Incident
- PUT `update-oncall-schedule` Update Oncall Schedule
- PUT `update-organisation-plan` Update Organisation Plan
- PUT `update-personal-notification-channel` Update Personal Notification Channel
- PUT `update-personal-notification-channel-status` Update Personal Notification Channel Status
- PUT `update-ruleset` Update Ruleset
- PUT `update-ruleset-actions` Update Ruleset Actions
- PUT `update-statuspage` Update Statuspage
- PUT `update-statuspage-status` Update Statuspage Status
- PUT `update-subscription` Update Subscription
- PUT `update-team-member` Update Team Member
- PUT `update-team-notification-channel` Update Team Notification Channel
- PUT `update-team-notification-channel-status` Update Team Notification Channel Status
- PUT `update-uptime-monitor` Update Uptime Monitor
- GET `view-heartbeat-statistics` View Heartbeat Statistics
- GET `view-uptime-monitor-performance-report` View Uptime Monitor Performance Report
- GET `view-uptime-monitor-response-log-history` View Uptime Monitor Response Log History
- GET `view-uptime-monitor-state-change-history` View Uptime Monitor State Change History