> ## 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

> 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

```text theme={null}
https://provisioning.cloudx.io/api/v1
```

## Authentication

Create an API key in [Settings > API Keys](https://app.cloudx.io/settings/api-keys), then send it as a bearer token:

```bash theme={null}
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.

| Permission            | Allows                                          |
| --------------------- | ----------------------------------------------- |
| `reports:read`        | Reporting endpoints under `/report/*`           |
| `auctions:read`       | Auction inspection endpoints under `/auction/*` |
| `configuration:read`  | Configuration endpoints under `/config/*`       |
| `configuration:write` | Configuration 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.