ReDoc documentation

system/config

system/config

Get system configuration values matching the given search criteria Standard Magento search: $searchCriteria's pageSize/currentPage drive real offset/limit pagination (0/unset pageSize preserves the legacy behavior of returning up to 500 paths with no paging); a "path" filter (single "eq" value or comma-separated "in" list) restricts the result to those specific paths instead of every allowed/visible one, in which case pageSize/ currentPage are ignored since the caller already controls the exact set requested — the returned pageSize/currentPage/totalCount then all reflect that single page. The result's echoed-back searchCriteria reflects the pageSize/currentPage actually applied.

Request
query Parameters
searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[sortOrders][0][field]
string

Sorting field.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[pageSize]
integer

Page size.

searchCriteria[currentPage]
integer

Current page.

scope
string

Scope type: default, website, store

scopeCode
string

Website code or store code; null for default scope

Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

get/V1/system/config
Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

system/config

Update system configuration with multiple options at once Every submitted item is accounted for in the returned result — either persisted (SystemConfigUpdateResultInterface::getItems()) or rejected with a reason (SystemConfigUpdateResultInterface::getErrors()): a restricted path, a path not found in system.xml/not visible for the given scope/not allowed by ACL, an invalid scope code, or a value rejected by a declarative field rule. Saving behavior otherwise matches admin UI save. Persisting one (section, scope) group is independent of another — one group failing to save does not prevent an unrelated group in the same request from being saved. This never throws for a per-item validation problem; an exception here means a genuinely unexpected failure (e.g. a database error).

Request
Request Body schema:
required
Array of objects (system-config-rest-data-system-config-item-interface)

Configuration items to save

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

put/V1/system/config
Request samples
{
  • "items": [
    ]
}
Response samples
{
  • "errors": [
    ],
  • "items": [
    ]
}