CloudHealth API

Name: CloudHealth API API
Brand: CloudHealth API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentFinanceExpense Managementbearer22 EndpointsREST

For Agents

Manage AWS account registration, SSO, perspectives, and cost reports inside CloudHealth using a bearer API token.

Quickstart

Get started with CloudHealth API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"list CloudHealth perspectives"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with CloudHealth API API.

Generate the AWS external ID needed for the cross-account IAM role

Configure and unconfigure SSO at /v1/sso/configure and /v1/sso/unconfigure

Create and manage perspectives that group cloud assets for cost allocation

GET STARTED

Start building with CloudHealth API API

Explore with Jentic

View OpenAPI Document

Use for: Register a new AWS account in CloudHealth, Generate the external ID for an AWS account onboarding, I want to configure SSO for my CloudHealth tenant, List all perspectives in my CloudHealth account

Not supported: Does not provision cloud resources, ingest billing data directly from cloud providers, or replace AWS Cost Explorer — use for CloudHealth tenant configuration and perspective reporting only.

Jentic publishes the only available OpenAPI document for CloudHealth API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for CloudHealth API, keeping it validated and agent-ready. CloudHealth (now part of Broadcom VMware) is a multi-cloud cost management platform. This variant of the spec covers AWS account onboarding, SSO configuration, perspective groupings used to slice cloud spend, reporting, and asset queries against the CloudHealth platform. Authentication is a bearer API token issued in the CloudHealth UI.

Use Cases

Patterns agents use CloudHealth API API for, with concrete tasks.

★ Automated AWS Account Onboarding

Register new AWS accounts in CloudHealth as part of a landing-zone provisioning pipeline. POST /v1/aws_accounts to add the account, call /v1/aws_accounts/{id}/generate_external_id to get the cross-account role's external ID, and feed it into the IAM role provisioning step. Removes the manual UI clicks from the multi-account onboarding runbook.

POST /v1/aws_accounts with the new account ID, then GET /v1/aws_accounts/{id}/generate_external_id and pass the value to the IAM role creation.

SSO Configuration Lifecycle

Manage SSO setup for a CloudHealth tenant programmatically. /v1/sso/configure registers the identity provider details, /v1/sso/configuration reads the current state, and /v1/sso/unconfigure tears it down. Pending domain claims are listed and validated through /v1/sso/pending_domain_claims so a script can complete the verification step.

POST /v1/sso/configure with the IdP metadata, then GET /v1/sso/pending_domain_claims and POST /v1/sso/validate_pending_domain_claim for each.

Perspective-Driven Cost Reporting

Slice cloud spend by business unit, environment, or product using CloudHealth perspectives, then read the values into a finance dashboard. /v1/perspective_schemas exposes how each perspective is grouped, and the reporting endpoints return spend by perspective for downstream BI.

GET /v1/perspective_schemas to list perspectives, then GET /v1/perspective_schemas/{perspective_id} for the chosen schema and pass the groupings to the reporting endpoint.

AI Agent FinOps Workflow

Let a Jentic-powered FinOps agent answer cost questions and onboard accounts. The agent searches Jentic for 'register AWS account in CloudHealth' or 'list CloudHealth perspectives', loads the matching operation, and executes it. The CloudHealth bearer token stays in the Jentic vault.

Search Jentic for 'list CloudHealth perspectives', load the listPerspectives operation, and execute it under the stored bearer token.

Key Endpoints

22 endpoints — jentic publishes the only available openapi specification for cloudhealth api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/v1/aws_accounts

List registered AWS accounts

POST

/v1/aws_accounts

GET

/v1/aws_accounts/{id}/generate_external_id

Generate the IAM external ID

POST

/v1/sso/configure

Configure SSO for the tenant

GET

/v1/sso/configuration

Read current SSO configuration

POST

/v1/sso/validate_pending_domain_claim

Validate a pending domain claim

GET

/v1/perspective_schemas

List perspective schemas

GET

/v1/perspective_schemas/{perspective_id}

Get a single perspective schema

GET

/v1/aws_accounts

List registered AWS accounts

POST

/v1/aws_accounts

GET

/v1/aws_accounts/{id}/generate_external_id

Generate the IAM external ID

POST

/v1/sso/configure

Configure SSO for the tenant

GET

/v1/sso/configuration

Read current SSO configuration

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

CloudHealth bearer API tokens are stored encrypted in the Jentic vault. Agents receive scoped access tokens — the raw token never enters the agent's context, which is critical because CloudHealth tokens read cost data across every onboarded AWS account.

Intent-based discovery

Agents search Jentic by intent (for example 'register AWS account in CloudHealth' or 'list cost perspectives') and Jentic returns the matching operation with its input schema so the agent calls the right /v1 endpoint.

Time to first call

Direct CloudHealth integration: 2-4 days for AWS account onboarding flows, SSO configuration, and perspective schema parsing. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

CloudHealth API

Alternate import of the CloudHealth spec with both bearer and ApiKey query auth.

Pick the main variant when the agent must authenticate via the api_key query parameter rather than a bearer token.

Alternative

AWS Cost Explorer

AWS-native cost and usage data without third-party FinOps tooling.

Choose Cost Explorer when the workload is single-cloud and CloudHealth licensing is unavailable.

Complementary

AWS Budgets

Threshold and forecast alerts on AWS spend.

Pair with CloudHealth so the agent can both report spend and trigger native AWS budget alarms.

FAQs

Specific to using CloudHealth API API through Jentic.

Why is there no official OpenAPI spec for CloudHealth API?

CloudHealth Technologies does not publish a structured OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CloudHealth API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the CloudHealth API use?

The API uses bearer token authentication. Generate an API token in the CloudHealth UI under My Profile and pass it as Authorization: Bearer <token>. Through Jentic, the token is stored encrypted in the vault and never enters the agent's context.

Can I onboard a new AWS account through the API?

Yes. POST /v1/aws_accounts with the account ID and metadata, then GET /v1/aws_accounts/{id}/generate_external_id for the external ID required by the cross-account IAM role. Apply that external ID when creating the role in AWS to complete onboarding.

How do I list cost perspectives through Jentic?

Run jentic search 'list CloudHealth perspectives', load the listPerspectiveSchemas operation, and execute GET /v1/perspective_schemas. Jentic handles the bearer token from the stored credential.

Can the API configure SSO for the tenant?

Yes. POST /v1/sso/configure registers the IdP metadata, GET /v1/sso/configuration reads the current state, and POST /v1/sso/unconfigure tears it down. Use /v1/sso/pending_domain_claims and /v1/sso/validate_pending_domain_claim to complete domain verification.

What is the difference between this CloudHealth spec and the cloudhealthtech.com main spec?

Both target chapi.cloudhealthtech.com. This cloudhealth-api variant uses bearer auth only and covers 22 endpoints. The main variant adds an alternative ApiKey query parameter scheme and one or two extra paths. Pick the variant that matches your auth approach.