ControlUp

ControlUp Health API

The Health API from ControlUp — 3 operation(s) for health.

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /health Check API and dependency health · Get health status #
Ask an LLM
“Is the ControlUp API healthy, including its dependencies?”
“Are any backend dependencies of the API reporting problems?”
Tell an agent
Check the health of the API and its dependencies.
Run a full health check including downstream dependencies.
GET /health/live Check that the API process is alive · Get liveness status #
Ask an LLM
“Is there a lightweight liveness probe that skips dependency checks?”
“Can I ping the API process to see if it is up?”
Tell an agent
Run the liveness probe without checking dependencies.
Ping the API process to confirm it's alive.
GET /health/info Get the deployed build version · Get build info #
Ask an LLM
“Which build version of the API is currently deployed?”
“Can I verify a deployment by reading the build metadata?”
Tell an agent
Show the deployed build info and version.
Get build metadata to verify the current deployment.

Documentation

📖
Documentation
https://api.controlup.io/reference
📖
APIReference
https://api.controlup.io/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/controlup/refs/heads/main/openapi/controlup-health-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/controlup:controlup-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

controlup-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: DaaS IQ Health API
  description: 'Multi-cloud Virtual Desktop Infrastructure Management API (Default Version: v1.0)


    🔒 **Authentication**


    This API supports two authentication methods:


    **1. API Key (Bearer Token)** - Recommended for programmatic access

    - Create an API key at API Key Management

    - Include in requests: `Authorization: Bearer YOUR_API_KEY`


    **2. Cookie Authentication** - For browser-based access

    - Login via DEX authentication service

    - The `user_dex_token` cookie will be automatically included'
  contact:
    name: ControlUp Support
    url: https://controlup.com/support
    email: support@controlup.com
  version: v1
  x-build-version: 1.0.107
servers:
- url: https://api.controlup.com/daas-iq/v1
tags:
- name: Health
paths:
  /health:
    get:
      tags:
      - Health
      summary: Get health status
      description: Returns the health status of the API and its dependencies.
      responses:
        '200':
          description: Health check successful
          content:
            text/plain:
              schema:
                type: string
                example: Healthy
      operationId: getHealth
      x-operation-id-source: derived
  /health/live:
    get:
      tags:
      - Health
      summary: Get liveness status
      description: Returns a lightweight process liveness response without checking external dependencies.
      responses:
        '200':
          description: API process is running
          content:
            text/plain:
              schema:
                type: string
                example: Healthy
      operationId: getHealthLive
      x-operation-id-source: derived
  /health/info:
    get:
      tags:
      - Health
      summary: Get build info
      description: Returns build metadata for deployment verification (version, etc.).
      responses:
        '200':
          description: Build info
          content:
            application/json:
              schema:
                type: object
                properties:
                  version:
                    type: string
                    example: 1.2.3
      operationId: getHealthInfo
      x-operation-id-source: derived
components:
  securitySchemes:
    BearerAuth:
      type: http
      description: '**API Key Authentication** (Recommended)


        [Learn how to create an API key](https://api.controlup.io/reference/how-to-create-api-keys).'
      scheme: bearer
      bearerFormat: JWT
    CookieAuth:
      type: apiKey
      description: '**Cookie Authentication** (Browser use)


        ⚠️ The ''Authorize'' button cannot set cookies due to browser security.


        To authenticate in browser:

        1. Login via DEX authentication service (same browser session)

        2. Or use DevTools Console: `document.cookie = "user_dex_token=YOUR_TOKEN; path=/"`'
      name: user_dex_token
      in: cookie
x-readme:
  explorer-enabled: true
  proxy-enabled: false
  samples-languages:
  - shell
  - powershell
  - node
  - javascript
  - python
  - c
  - clojure
  - cplusplus
  - csharp
  - http
  - go
  - java
  - json
  - kotlin
  - objectivec
  - ocaml
  - php
  - r
  - ruby
  - swift