What this is

The CloudFix API lets you automate access to recommendations, reports, integrations, and administrative configuration for your CloudFix tenant.

Who this guide is for

• CloudFix admins who manage users, integrations, and settings
• Developers who want to pull recommendations and reports
• Partners or integration engineers who need webhooks or API tokens

Base URL

https://app.cloudfix.com/api/v3

Authentication

Most endpoints require an Authorization header. CloudFix supports these formats:

• Authorization: Bearer
• Authorization: api-token
• Authorization: cft_

Choose your auth method

You can authenticate either by logging in and using a session token (Bearer) or by generating an API token in the CloudFix UI for automation. Both methods work with the same API endpoints; choose the one that matches your use case.

Public endpoints (no auth required) are limited to login/registration, token refresh, and a small set of onboarding and marketplace flows. If an endpoint is public, it is explicitly listed in the technical summary.

How to get a token

• For user access, sign in to CloudFix and use the session token returned by login/SSO.
• For automation, use API tokens. Tokens are tenant-scoped and can be created and revoked by authorized users in the UI or via the API.

Authorization and permissions

Access is role-based. Each API route maps to a permission set. If you see 403 errors, your user or token lacks the required permissions for that action.

Data persistence

• CloudFix stores configuration, recommendations, and reports server-side.
• Webhook and integration settings are persistent and remain active until updated or deleted.
• Token lifecycle and revocation are managed by the backend.
• Retention periods vary by plan and policy; contact CloudFix Support for retention details.

Not in scope for the API

These CloudFix UI features are not directly exposed as API endpoints:

• UI-only rendering and exports (charts, PDF exports, report layout)
• Viewer-only report presentation (the API returns data and share URLs; the UI controls the viewing experience)
• One-click UI execution controls beyond the API change-request and scheduling endpoints
• Client analytics and telemetry built into the UI

Common tasks by persona

Admin

Typical goals:

• Manage users
• Manage API tokens
• Configure integrations and webhooks
• Configure finders/fixers settings and excluded accounts

Relevant capabilities:

• Users: list, create, update, delete
• Tokens: create, list, revoke
• Integrations: email integrations and webhooks
• Settings: excluded accounts, finders configuration, execution schedules

Developer

Typical goals:

• Retrieve recommendations
• Pull summary views or reports
• Access savings and cost ranking reports

Relevant capabilities:

• Recommendations: list, summary, filters, report export
• Reports: savings, realized savings, savings history, cost ranking
• Validations and analysis status

Partner or integration engineer

Typical goals:

• Register and manage webhooks
• Sync or maintain email integration config
• Use tokens for automation

Relevant capabilities:

• Webhooks: register, list, delete
• Email integrations: register, edit, delete, sync
• API tokens for service accounts

Walkthrough: get a token, list recommendations, and take action

This is a simple end-to-end flow you can follow in production.

1) Get an API token in the UI In the CloudFix UI, create an API token for your user or service account. Use it in the Authorization header as api-token <token>.

2) List recommendations Call the recommendations endpoint to get individual recommendation IDs: 

GET /api/v3/recommendations?pageNumber=1&pageLimit=50

3) Group recommendations Use the summary endpoints to group by recommendation type and scope to OUs/accounts/regions/tags: 

GET /api/v3/recommendations/summary 

GET /api/v3/recommendations/summary-filters

4) Act on recommendations Use IDs from the recommendations list to snooze, mark fixed, or create change requests: 

POST /api/v3/recommendations/postpone 

POST /api/v3/recommendations/manual-fix 

POST /api/v3/create-change-requests

5) View reports Use the recommendation ID to fetch a report and optionally generate a share link: 

GET /api/v3/recommendations/report?recommendationId=<id> 

POST /api/v3/shared-reports

Making the summary useful

The recommendations summary is an aggregate view that groups findings by recommendation type. It is designed for prioritization and tracking, not for item-by-item actions.

How to use it effectively:

• Prioritize by potentialSavings and resourcesTotal to decide which recommendation types to tackle first.
• Use categoryTypeName and supportsAutoFix to separate quick wins from maintenance-window work.
• Track progress over time with completedSavings and realizedSavings.
• Use subCategoryTypeName and subCategoryTypeDescription as the human-friendly identifier for each recommendation type.

Using summary filters

The summary filters endpoint provides the allowed filter values (organizational units, accounts, regions, and tags) for your tenant. Use these values to build precise summary queries, for example:

• Filter the summary to a single OU or account to focus on one business unit.
• Filter by region or tag to align with cost-center or environment-specific reporting.

From summary to a single recommendation

The summary does not include recommendation IDs by design. To retrieve individual recommendations, use the recommendations list endpoint with filters:

• Use the recommendation type from summary (subCategoryTypeName) with the /recommendations finderFixerId filter to get concrete recommendation IDs.
• If you need to scope to an account, use filterBy=accountId and filterValue=.
• Then use those IDs for actions like report retrieval, manual fixes, or change requests.