config/history

GET/config/history

List up to 200 of the most recent config history rows with publish-time diff metadata. Results are newest first and are not an exhaustive account history. Requires the configuration:read permission.

Request

cURL
curl -X GET "https://provisioning.cloudx.io/api/v1/config/history" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Query parameters

NameTypeDescription
sincestringOnly include configuration rows created at or after this time. Supports RFC3339 timestamps or YYYY-MM-DD dates.
authorstringFilter by creator user ID, email, or name substring.
include_draftsbooleanWhether to include configuration drafts. By default, only published versions are returned.
limitinteger<int32>Maximum number of the most recent rows to return.

Responses

Config history rows.
{
  "entries": [
    {
      "id": "<string>",
      "account_id": "<string>",
      "kind": "version",
      "version_number": 123,
      "version_label": "<string>",
      "created_at": "<string>",
      "created_by_user_id": "<string>",
      "created_by_name": "<string>",
      "description": "<string>",
      "diff_additions": 123,
      "diff_deletions": 123
    }
  ]
}

200 Config history rows.

FieldTypeDescription
entriesrequiredarray of object

400 Invalid request parameters.

FieldTypeDescription
errorrequiredstring

401 Unauthorized.

FieldTypeDescription
errorrequiredstring

403 Forbidden.

FieldTypeDescription
errorrequiredstring

500 Internal server error.

FieldTypeDescription
errorrequiredstring