CloudX API

Authenticate requests and use the CloudX API reference.

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 and activity-export endpoints under /report/* and /export/*
auctions:readAuction inspection endpoints under /auction/*
configuration:readConfiguration endpoints under /config/*
configuration:writeConfiguration write endpoints under /config/*

Activity Exports

Create asynchronous, full-day activity-export reports with POST /export/impressions, POST /export/requests, or POST /export/bids, then poll the matching GET endpoint until the export is ready.

Most reports are ready to download within 5–45 minutes. Processing time varies with the amount of data for the selected date and filters. When the export is ready, the status response includes a short-lived download URL.

See Activity Exports for request bodies, polling examples, and the CSV schemas returned by both the API and CLI.

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.