Cycle LogoSTATUS

Cycle Status API

Documentation and functionality for retrieving information about the status of the Cycle Platform.

Basics

The following documentation is provided for those who want to access the status of Cycle programmatically. Endpoints are shown with examples using cURL.

Endpoints

GET /api/v1/status

Retrieves the overall status of Cycle, and the status of the individual services that make up the platform.

curl https://status.cycle.io/api/v1/status

Return

{
  "data": {
    "platform": "online", // Can be online, upgrading, degraded, partial-outage, or offline.
    "services": [
      {
        "name": "Console",
        "description": "Cycle's console service. Provides SSH access to containers in a safe and centralized manner.",
        "percent_online": 100,
        "percent_upgrading": 0,
        "status": "online" // Can be online, upgrading, degraded, or offline.
      },
      {
        "name": "DNS",
        "description": "Cycle's Domain Name Service. Provides routing for domains pointed to Cycle's nameservers.",
        "percent_online": 75,
        "percent_upgrading": 0,
        "status": "degraded"
      },
      {
        "name": "Auth",
        "description": "Cycle's auth service provides user authentication and access to the portal and APIs.",
        "percent_online": 100,
        "percent_upgrading": 50,
        "status": "upgrading"
      },
      {
        "name": "Portal",
        "description": "The portal provides a user friendly interface for managing containers and infrastructure.",
        "percent_online": 0,
        "percent_upgrading": 0,
        "status": "offline"
      },
      {
        "name": "Nexus",
        "description": "Communication mesh for Cycle's core services.",
        "percent_online": 100,
        "percent_upgrading": 0,
        "status": "online"
      },
      {
        "name": "Factory",
        "description": "Cycle's factory service builds container images during stack imports.",
        "percent_online": 100,
        "percent_upgrading": 0,
        "status": "online"
      },
      {
        "name": "Compute Proxy",
        "description": "The compute proxy service routes requests between the central platform and client servers.",
        "percent_online": 100,
        "percent_upgrading": 0,
        "status": "online"
      },
      {
        "name": "Public API",
        "description": "Cycle's public API enables both users and the portal to interact with the platform.",
        "percent_online": 100,
        "percent_upgrading": 0,
        "status": "online"
      },
      {
        "name": "Manager",
        "description": "Job scheduling and delegator for Cycle services.",
        "percent_online": 100,
        "percent_upgrading": 0,
        "status": "online"
      },
      {
        "name": "Monitor",
        "description": "This service monitors server and environment metrics, and does public ping uptime monitoring for load balancers",
        "percent_online": 100,
        "percent_upgrading": 0,
        "status": "online"
      }
    ]
  }
}