Skip to main content
POST
/
config
/
edit
config/edit
curl --request POST \
  --url https://provisioning.cloudx.io/api/v1/config/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "summary": "<string>",
  "operations": [
    {
      "create_line_item": [
        {}
      ]
    }
  ],
  "config_id": "<string>"
}
'
{
  "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>"
    }
  }
}

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.

Authorizations

​
Authorization
string
header
default:YOUR_CLOUDX_API_KEY
required

Create or manage API keys in CloudX Settings.

Body

application/json
​
summary
string
required

Draft name or edit summary.

​
operations
object[]
required
Minimum array length: 1

One typed config edit operation. Each operation object must contain exactly one line-item action key.

​
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.

Response

Draft config containing the applied edits.

​
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