config/edit

Apply typed app, ad unit, ad unit group, list, tag, test-device, line-item, and A/B test config edits. Requires the configuration:write permission. Ordinary edit actions and A/B test create return draft configs. A/B test update, start, end, promote, and delete publish the resulting configuration as live.

POST /config/edit

config/edit

cURL

curl --request POST \
  --url https://provisioning.cloudx.io/api/v1/config/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operations": [
    {
      "create_app": [
        {}
      ]
    }
  ],
  "config_id": "<string>",
  "summary": "<string>"
}
'

200

{
  "id": "<string>",
  "account_id": "<string>",
  "created": true,
  "base_config_id": "<string>",
  "applied_paths": [
    "<string>"
  ],
  "validation": {
    "valid": true,
    "error_count": 123,
    "warning_count": 123,
    "issues": [
      {
        "code": "<string>",
        "message": "<string>",
        "path": "<string>",
        "line": 123,
        "column": 123,
        "length": 123
      }
    ],
    "yaml": "<string>",
    "source": {
      "type": "<string>",
      "name": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · default: YOUR_CLOUDX_API_KEY · required

Create or manage API keys in CloudX Settings.

Body

application/json

operations · object[] · required

Minimum array length: 1

One typed config edit operation. Each operation object must contain exactly one supported action key.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Option 24

Option 25

Option 26

Option 27

Show child attributes

config_id · string

Config row ID to edit. Defaults to the current live config. Draft configs are edited in place; published configs are copied into a new draft.

summary · string

Draft name or edit summary. Required for ordinary draft edits. Optional for A/B test operations; when provided, it is used as the draft or published version label.

Response

200

application/json

Result of the applied config edit. Ordinary edits and A/B test create return a draft result; A/B test update, start, end, promote, and delete return a published config result.

Option 1

Option 2

Option 3

id · string · required

Draft config ID containing the edited config.

account_id · string · required

kind · enum<string> · required

Available options: draft

created · boolean · required

True when a new draft was created from a published or live config.

base_config_id · string · required

Source config row ID that was edited or copied.

applied_paths · string[] · required

validation · object · required

Show child attributes