Optimizely

Optimizely Rule Managers API

The Rule Managers API from Optimizely — 8 operation(s) for rule managers.

GitHub OpenAPI

Operations 12

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/RuleManagers List rule managers · Returns the EntitySet RuleManagers #
Ask an LLM
“Which rule managers are defined in my commerce admin?”
“Can I filter rule managers by rule type?”
Tell an agent
List all rule managers.
List rule managers matching {filter}.
POST /api/v1/admin/RuleManagers Create a rule manager · Post a new entity to EntitySet RuleManagers #
Ask an LLM
“How do I create a new rule manager for my commerce rules?”
“Can I assign a rule type when creating a rule manager?”
Tell an agent
Create a rule manager named {name}.
Create rule manager {name} of rule type {ruleTypeId}.
GET /api/v1/admin/RuleManagers({id}) Get a rule manager · Returns the entity with the key from RuleManagers #
Ask an LLM
“What rule type does a given rule manager use?”
“Can I fetch one rule manager by its ID?”
Tell an agent
Get rule manager {id}.
Show the details of rule manager {id}.
PUT /api/v1/admin/RuleManagers({id}) Replace a rule manager · Replace entity in EntitySet RuleManagers #
Ask an LLM
“How do I overwrite a rule manager record in full?”
“Does replacing a rule manager reset fields I leave out?”
Tell an agent
Replace rule manager {id} with a full record named {name}.
Overwrite rule manager {id}, setting rule type {ruleTypeId}.
DELETE /api/v1/admin/RuleManagers({id}) Delete a rule manager · Delete entity in EntitySet RuleManagers #
Ask an LLM
“Can I delete a single rule manager by ID?”
“Is there a way to delete a rule manager only if its ETag matches?”
Tell an agent destructive · confirm first
Delete rule manager {id}.
Delete rule manager {id} if its ETag is {etag}.
PATCH /api/v1/admin/RuleManagers({id}) Update a rule manager · Update entity in EntitySet RuleManagers #
Ask an LLM
“How do I rename an existing rule manager?”
“Can I change a rule manager's rule type without replacing it?”
Tell an agent
Rename rule manager {id} to {name}.
Patch rule manager {id} to use rule type {ruleTypeId}.
GET /api/v1/admin/RuleManagers/Default.Default() Get a blank rule manager template · Call operation Default #
Ask an LLM
“What default values does a new rule manager have?”
“Can I get an empty rule manager template first?”
Tell an agent
Fetch the default rule manager template.
Show the starting values for a new rule manager.
POST /api/v1/admin/RuleManagers({id})/Default.rules Set the rule clauses of a rule manager · Call operation rules #
Ask an LLM
“How do I define the rule clauses a rule manager evaluates?”
“Can I replace a rule manager's rules with a new set of clauses?”
Tell an agent
Set the rule clauses of rule manager {id} to {ruleClauses}.
Apply these clauses to rule manager {id} via the Default.rules action: {ruleClauses}.
POST /api/v1/admin/rulemanagers({key})/rules Set rules via the rule manager key route · Rule managers set rules by key #
Ask an LLM
“Is there a route-style rules endpoint keyed by the rule manager key?”
“What happens when I post to the key-addressed rules path of a rule manager?”
Tell an agent
Post rules to rule manager {key} through the key-based rules route.
Call the rulemanagers rules route for key {key}.
DELETE /api/v1/admin/rulemanagers/delete Bulk delete rule managers · Rule managers delete route #
Ask an LLM
“Can I delete several rule managers at once?”
“How do I remove a list of rule managers by ID in a single call?”
Tell an agent destructive · confirm first
Bulk delete rule managers {ids}.
Remove these rule managers together: {ids}.
GET /api/v1/admin/rulemanagers({key})/customproperties({custompropertyKey}) Get a custom property on a rule manager · Rule managers get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a rule manager?”
“What extra custom values are attached to a rule manager?”
Tell an agent
Get custom property {custompropertyKey} on rule manager {key}.
Show rule manager {key}'s custom property {custompropertyKey}.
GET /api/v1/admin/rulemanagers({key})/ruleclauses({ruleclauseKey}) Get one rule clause of a rule manager · Rule managers get rule clause by key and ruleclausekey #
Ask an LLM
“What condition does a single rule clause in a rule manager check?”
“Can I inspect one clause belonging to a rule manager?”
Tell an agent
Get rule clause {ruleclauseKey} of rule manager {key}.
Show clause {ruleclauseKey} in rule manager {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-rule-managers-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-rule-managers-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-rule-managers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Rule Managers API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Rule Managers
paths:
  /api/v1/admin/RuleManagers:
    get:
      tags:
      - Rule Managers
      summary: Returns the EntitySet RuleManagers
      operationId: RuleManagers_Get
      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:
      - Rule Managers
      summary: Post a new entity to EntitySet RuleManagers
      operationId: RuleManagers_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.RuleManager'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RuleManagers({id}):
    get:
      tags:
      - Rule Managers
      summary: Returns the entity with the key from RuleManagers
      operationId: RuleManagers_GetById
      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:
      - Rule Managers
      summary: Replace entity in EntitySet RuleManagers
      operationId: RuleManagers_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.RuleManager'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Rule Managers
      summary: Delete entity in EntitySet RuleManagers
      operationId: RuleManagers_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:
      - Rule Managers
      summary: Update entity in EntitySet RuleManagers
      operationId: RuleManagers_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.RuleManager'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RuleManagers/Default.Default():
    get:
      tags:
      - Rule Managers
      summary: Call operation Default
      operationId: RuleManagers_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RuleManagers({id})/Default.rules:
    post:
      tags:
      - Rule Managers
      summary: Call operation rules
      operationId: RuleManagers_SetRulesById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ruleClauses:
                  type: array
                  items:
                    $ref: '#/components/schemas/Insite.Data.Entities.RuleClause'
        description: rules action parameters
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/rulemanagers({key})/rules:
    post:
      tags:
      - Rule Managers
      operationId: RuleManagers_SetRulesByKey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Rule managers set rules by key
      x-summary-source: derived
  /api/v1/admin/rulemanagers/delete:
    delete:
      tags:
      - Rule Managers
      operationId: RuleManagers_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: Rule managers delete route
      x-summary-source: derived
  /api/v1/admin/rulemanagers({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Rule Managers
      operationId: RuleManagers_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: Rule managers get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/rulemanagers({key})/ruleclauses({ruleclauseKey}):
    get:
      tags:
      - Rule Managers
      operationId: RuleManagers_GetRuleClauseByKeyAndRuleclausekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: ruleclauseKey
        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: Rule managers get rule clause by key and ruleclausekey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.RuleManager:
      required:
      - name
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        ruleTypeId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 100
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
    Insite.Data.Entities.RuleClause:
      required:
      - condition
      - criteriaType
      - criteriaObject
      - criteriaProperty
      - criteriaValue
      - comparisonOperator
      - simpleValue
      - valueList
      - valueMinimum
      - valueMaximum
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        ruleManagerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        ruleTypeOptionId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        executionGroup:
          format: int32
          type: integer
        executionOrder:
          format: int32
          type: integer
        condition:
          maxLength: 50
          minLength: 0
          type: string
        criteriaType:
          maxLength: 50
          minLength: 0
          type: string
        criteriaObject:
          maxLength: 255
          minLength: 0
          type: string
        criteriaProperty:
          maxLength: 100
          minLength: 0
          type: string
        criteriaValue:
          maxLength: 255
          minLength: 0
          type: string
        comparisonOperator:
          maxLength: 50
          minLength: 0
          type: string
        simpleValue:
          maxLength: 2048
          minLength: 0
          type: string
        valueList:
          maxLength: 2048
          minLength: 0
          type: string
        valueMinimum:
          maxLength: 100
          minLength: 0
          type: string
        valueMaximum:
          maxLength: 100
          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