Skip to main content

​
CloudX API

Use the CloudX API to retrieve reporting metrics, inspect auctions, and read or write 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/*
configuration:writeConfiguration write endpoints under /config/*

​
Configuration Writes

Use POST /config/edit to create or update a config draft for apps, ad units, ad unit groups, lists, tags, test devices, network mappings, and line items. The same endpoint also accepts A/B test operations; creating an A/B test returns a draft, while update, start, end, promote, and delete publish the resulting config. Requests use typed operation keys such as create_app, update_ad_unit, upsert_network_mapping, and update_line_item. Ad-unit and line-item bidfloor values are decimal USD CPM, so 1.5 means $1.50 CPM.

​
API Reference

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