Optimizely

Optimizely System Settings API

The System Settings API from Optimizely — 14 operation(s) for system settings.

GitHub OpenAPI

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/SystemSettings List system settings · Returns the EntitySet SystemSettings #
Ask an LLM
“How do I see every system setting configured in my Optimizely Configured Commerce admin?”
“Can I filter the system settings list down to ones whose name matches a condition?”
Tell an agent
List all system settings.
List system settings matching the filter {filter}.
POST /api/v1/admin/SystemSettings Create a system setting · Post a new entity to EntitySet SystemSettings #
Ask an LLM
“How do I add a new named system setting with a value?”
“Can a new system setting be scoped to a single website?”
Tell an agent
Create a system setting named {name} with value {value}.
Add system setting {name} = {value} for website {websiteId}.
GET /api/v1/admin/SystemSettings({id}) Get a system setting by its id · Returns the entity with the key from SystemSettings #
Ask an LLM
“What value does the system setting with a given id currently hold?”
“Can I fetch one system setting record using its GUID id?”
Tell an agent
Get the system setting with id {id}.
Show the name and value of system setting record {id}.
PUT /api/v1/admin/SystemSettings({id}) Replace a system setting · Replace entity in EntitySet SystemSettings #
Ask an LLM
“How do I overwrite an entire system setting record rather than patching one field?”
“Can I fully replace a system setting's name and value in one call?”
Tell an agent
Replace system setting {id} with name {name} and value {value}.
Fully overwrite the record for system setting {id}.
DELETE /api/v1/admin/SystemSettings({id}) Delete a system setting · Delete entity in EntitySet SystemSettings #
Ask an LLM
“How do I remove a single system setting by its id?”
“Can I guard a system setting deletion with an ETag so I don't delete a changed record?”
Tell an agent destructive · confirm first
Delete system setting {id}.
Delete system setting {id} only if its ETag still matches {etag}.
PATCH /api/v1/admin/SystemSettings({id}) Update a system setting's value · Update entity in EntitySet SystemSettings #
Ask an LLM
“How do I change the value of an existing system setting?”
“Can I partially update a system setting without resending the whole record?”
Tell an agent
Update system setting {id} to value {value}.
Patch system setting {id} so it applies to website {websiteId}.
GET /api/v1/admin/SystemSettings/Default.Default() Get a blank default system setting · Call operation Default #
Ask an LLM
“What does an empty system setting record look like before I fill it in?”
“Is there a default template object for a new system setting?”
Tell an agent
Get the default template for a new system setting.
Show me the blank default system setting object.
POST /api/v1/admin/SystemSettings/Default.batch Save many settings via the Default.batch action · Call operation batch #
Ask an LLM
“Can I save a whole set of settings for a website in one OData batch action?”
“How do I bulk-set settings using the Default.batch operation?”
Tell an agent
Save settings {settings} for website {websiteId} using the Default.batch action.
Run the OData Default.batch action with settings {settings}.
POST /api/v1/admin/SystemSettings/Default.restore Restore settings via the Default.restore action · Call operation restore #
Ask an LLM
“How do I restore a group of settings for a website with the Default.restore action?”
“Can I roll listed settings back using the OData restore operation?”
Tell an agent
Restore settings {settings} for website {websiteId} with the Default.restore action.
Call the OData Default.restore action for settings {settings}.
POST /api/v1/admin/SystemSettings/Default.test Test a settings group via Default.test · Call operation test #
Ask an LLM
“Can I test a settings group's configuration before relying on it?”
“How do I run the Default.test action against a specific settings group?”
Tell an agent
Test settings group {settingsGroup} using the Default.test action.
Run the OData Default.test check on settings group {settingsGroup}.
GET /api/v1/admin/SystemSettings/Default.Groups(websiteId={websiteId}) List setting groups via the Default.Groups function · Call operation Groups #
Ask an LLM
“Which settings groups exist for a given website, via the OData Default.Groups function?”
“How do I call Default.Groups to see a website's setting groups?”
Tell an agent
Get setting groups for website {websiteId} using the Default.Groups function.
Call Default.Groups for website {websiteId}.
GET /api/v1/admin/systemsettings({key}) Get a system setting by key · System settings get single by key #
Ask an LLM
“How do I look up a system setting using its key on the lowercase systemsettings route?”
“Can I fetch a setting by key and pick only certain properties?”
Tell an agent
Get the system setting with key {key}.
Look up system setting key {key} and return only {select}.
GET /api/v1/admin/systemsettings/groups(websiteId={websiteId}) List setting groups on the plain groups route · System settings get groups by websiteid 2 #
Ask an LLM
“What setting groups does a website have, using the lowercase systemsettings/groups route?”
“Is there a non-OData-action route to list a website's settings groups?”
Tell an agent
List settings groups for website {websiteId} from the systemsettings/groups route.
Fetch website {websiteId}'s setting groups via the plain groups endpoint.
POST /api/v1/admin/systemsettings/test Test settings on the plain test route · System settings test 2 #
Ask an LLM
“Is there a parameterless systemsettings/test route for checking settings?”
“Can I trigger a settings test through the lowercase test endpoint?”
Tell an agent
Run a settings test through the plain systemsettings/test route.
Call the lowercase settings test endpoint.
POST /api/v1/admin/systemsettings/batch Save settings on the plain batch route · System settings set settings 2 #
Ask an LLM
“Is there a plain systemsettings/batch route, separate from the Default.batch action?”
“Can I post a settings batch to the lowercase batch endpoint?”
Tell an agent
Post a settings batch to the plain systemsettings/batch route.
Save settings in bulk through the lowercase batch endpoint.
POST /api/v1/admin/systemsettings/restore Restore settings on the plain restore route · System settings restore settings 2 #
Ask an LLM
“Is there a plain systemsettings/restore route besides the Default.restore action?”
“Can I restore settings by posting to the lowercase restore endpoint?”
Tell an agent
Restore settings through the plain systemsettings/restore route.
Call the lowercase settings restore endpoint.
DELETE /api/v1/admin/systemsettings/delete Delete several system settings at once · System settings delete route #
Ask an LLM
“How do I delete multiple system settings in a single request?”
“Can I bulk-remove system settings by passing a list of ids?”
Tell an agent destructive · confirm first
Delete the system settings with ids {ids}.
Bulk-remove system settings {ids}.
GET /api/v1/admin/systemsettings({key})/customproperties({custompropertyKey}) Get a custom property of a system setting · System settings get custom property by key and custompropertykey #
Ask an LLM
“Can system settings carry custom properties, and how do I read one?”
“How do I fetch one custom property attached to a system setting?”
Tell an agent
Get custom property {custompropertyKey} on system setting {key}.
Show the value of custom property {custompropertyKey} for setting {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-system-settings-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-system-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-system-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 System Settings API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: System Settings
paths:
  /api/v1/admin/SystemSettings:
    get:
      tags:
      - System Settings
      summary: Returns the EntitySet SystemSettings
      operationId: SystemSettings_GetList
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - System Settings
      summary: Post a new entity to EntitySet SystemSettings
      operationId: SystemSettings_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SystemSetting'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemSettings({id}):
    get:
      tags:
      - System Settings
      summary: Returns the entity with the key from SystemSettings
      operationId: SystemSettings_GetSingleById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - System Settings
      summary: Replace entity in EntitySet SystemSettings
      operationId: SystemSettings_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SystemSetting'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - System Settings
      summary: Delete entity in EntitySet SystemSettings
      operationId: SystemSettings_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - System Settings
      summary: Update entity in EntitySet SystemSettings
      operationId: SystemSettings_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SystemSetting'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemSettings/Default.Default():
    get:
      tags:
      - System Settings
      summary: Call operation Default
      operationId: SystemSettings_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemSettings/Default.batch:
    post:
      tags:
      - System Settings
      summary: Call operation batch
      operationId: SystemSettings_SetSettings_1
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                settings:
                  type: array
                  items:
                    $ref: '#/components/schemas/Insite.Admin.SystemSettings.SystemSettingDto'
                websiteId:
                  format: guid
                  type: string
        description: batch action parameters
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemSettings/Default.restore:
    post:
      tags:
      - System Settings
      summary: Call operation restore
      operationId: SystemSettings_RestoreSettings_1
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                settings:
                  type: array
                  items:
                    $ref: '#/components/schemas/Insite.Admin.SystemSettings.SystemSettingDto'
                websiteId:
                  format: guid
                  type: string
        description: restore action parameters
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemSettings/Default.test:
    post:
      tags:
      - System Settings
      summary: Call operation test
      operationId: SystemSettings_Test_1
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                settingsGroup:
                  type: string
        description: test action parameters
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemSettings/Default.Groups(websiteId={websiteId}):
    get:
      tags:
      - System Settings
      summary: Call operation Groups
      operationId: SystemSettings_GetGroupsByWebsiteid_1
      parameters:
      - name: websiteId
        in: path
        description: 'parameter: websiteId'
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/systemsettings({key}):
    get:
      tags:
      - System Settings
      operationId: SystemSettings_GetSingleByKey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System settings get single by key
      x-summary-source: derived
  /api/v1/admin/systemsettings/groups(websiteId={websiteId}):
    get:
      tags:
      - System Settings
      operationId: SystemSettings_GetGroupsByWebsiteid_2
      parameters:
      - name: websiteId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System settings get groups by websiteid 2
      x-summary-source: derived
  /api/v1/admin/systemsettings/test:
    post:
      tags:
      - System Settings
      operationId: SystemSettings_Test_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System settings test 2
      x-summary-source: derived
  /api/v1/admin/systemsettings/batch:
    post:
      tags:
      - System Settings
      operationId: SystemSettings_SetSettings_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System settings set settings 2
      x-summary-source: derived
  /api/v1/admin/systemsettings/restore:
    post:
      tags:
      - System Settings
      operationId: SystemSettings_RestoreSettings_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System settings restore settings 2
      x-summary-source: derived
  /api/v1/admin/systemsettings/delete:
    delete:
      tags:
      - System Settings
      operationId: SystemSettings_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System settings delete route
      x-summary-source: derived
  /api/v1/admin/systemsettings({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - System Settings
      operationId: SystemSettings_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System settings get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Admin.SystemSettings.SystemSettingDto:
      type: object
      properties:
        name:
          type: string
        groupName:
          type: string
        displayName:
          type: string
        description:
          type: string
        isGlobal:
          type: boolean
        websiteSpecificOnly:
          type: boolean
        isEncrypted:
          type: boolean
        sortOrder:
          format: int32
          type: integer
        type:
          type: string
        controlType:
          type: string
        value:
          type: string
        defaultValue:
          type: string
        minValue:
          format: double
          type: number
        maxValue:
          format: double
          type: number
        valueSeparator:
          type: string
        toggleValues:
          type: array
          items:
            type: string
        displayWebsiteSpecificValueIndicator:
          type: boolean
        pluralizedEntityName:
          type: string
        isHidden:
          type: boolean
        regexValidation:
          type: string
        required:
          type: boolean
        preventTrimValue:
          type: boolean
        restored:
          type: boolean
        isConfigurationValue:
          type: boolean
        overrideAll:
          type: boolean
        searchProviderTag:
          type: string
    Insite.Data.Entities.SystemSetting:
      required:
      - name
      - value
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 256
          minLength: 0
          type: string
        websiteId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        value:
          maxLength: 1024
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query