Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cloudx.io/llms.txt

Use this file to discover all available pages before exploring further.

CloudX API

Use the CloudX API to retrieve reporting metrics, inspect auctions, and read account configuration.

Base URL

https://provisioning.cloudx.io/api/v1

Authentication

Create an API key in Settings > API Keys, then send it as a bearer token:
curl https://provisioning.cloudx.io/api/v1/auth/status \
  -H "Authorization: Bearer $CLOUDX_API_KEY"
Only administrators can create, manage, and revoke API keys.

Permissions

Choose permissions based on the endpoints your integration needs.
PermissionAllows
reports:readReporting endpoints under /report/*
auctions:readAuction inspection endpoints under /auction/*
configuration:readConfiguration endpoints under /config/*

API Reference

The API reference is generated from the live OpenAPI schema hosted by CloudX.