Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Acquia Current system health API

The Current system health API from Acquia — 1 operation(s) for current system health.

Acquia Current system health API is one of 21 APIs that Acquia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Current system health. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

1 operations 1 paths 2 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Authentication
OAuth 2.0, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Acquia Current system health API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (Acquia_Cloud_API_Documentation_OAuth2) using the clientCredentials flow. An API key is passed in the header as Authorization (Codebase_Service_JWT). An API key is passed in the header as Authorization (MEO_Environment_Service_JWT). An API key is passed in the header as Authorization (Site_Service_JWT).

  • Acquia_Cloud_API_Documentation_OAuth2 — All Cloud API calls need to be authenticated in order to work. You authenticate using a token that you can generate on your Acquia Profile page. To generate a…
  • Codebase_Service_JWT — Value for the Authorization header parameter.
  • MEO_Environment_Service_JWT — Value for the Authorization header parameter.
  • Site_Service_JWT — Value for the Authorization header parameter.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Current system health 1
GET
/
Acquia Return the Current System Health Status.
getSystemHealthStatus → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_root (2 properties), Acquia_Cloud_API_Documentation_links (1 property). Each schema is shown below with its type and property counts.

Acquia_Cloud_API_Documentation_root
object
2 properties 2 required
Acquia_Cloud_API_Documentation_links
object
HAL links about the current resource.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-current-system-health-api-openapi.yml Raw ↑

Other APIs Acquia publishes across the network.

Acquia Cloud Site Factory API
Acquia Content Hub API
Acquia Account API
Acquia Agreements API
Acquia Application Performance Monitoring Services API
Acquia Applications API
Acquia Cloud IDE API
Acquia Codebases API
Acquia Distributions API
Acquia Email API
Acquia Environments API
Acquia Identity Providers API