Alibaba Sentinel Flow Rules API

openapi: 3.0.3
info:
  title: Alibaba Sentinel Dashboard Authority Rules Flow Rules API
  description: REST API for the Sentinel Dashboard providing management of flow rules, degrade rules, system rules, and authority rules for resources.
  version: 1.8.0
  contact:
    name: Alibaba Sentinel
    url: https://github.com/alibaba/Sentinel
servers:
- url: http://localhost:8080
  description: Default Sentinel Dashboard
tags:
- name: Flow Rules
paths:
  /v1/flow/rules:
    get:
      operationId: getFlowRules
      summary: Get flow rules for an application
      tags:
      - Flow Rules
      parameters:
      - name: app
        in: query
        required: true
        schema:
          type: string
        description: Application name
      responses:
        '200':
          description: List of flow rules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResult'
  /v1/flow/rule:
    post:
      operationId: createFlowRule
      summary: Create a new flow rule
      tags:
      - Flow Rules
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FlowRuleRequest'
      responses:
        '200':
          description: Flow rule created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResult'
    put:
      operationId: updateFlowRule
      summary: Update an existing flow rule
      tags:
      - Flow Rules
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FlowRuleRequest'
      responses:
        '200':
          description: Flow rule updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResult'
    delete:
      operationId: deleteFlowRule
      summary: Delete a flow rule
      tags:
      - Flow Rules
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: integer
      - name: app
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Flow rule deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResult'
components:
  schemas:
    ApiResult:
      type: object
      properties:
        code:
          type: integer
          description: Response code (200 for success)
        msg:
          type: string
          description: Response message
        data:
          description: Response data payload
    FlowRuleRequest:
      type: object
      required:
      - app
      - resource
      - count
      properties:
        id:
          type: integer
        app:
          type: string
        resource:
          type: string
        limitApp:
          type: string
          default: default
        grade:
          type: integer
          enum:
          - 0
          - 1
          default: 1
        count:
          type: number
        strategy:
          type: integer
          enum:
          - 0
          - 1
          - 2
          default: 0
        refResource:
          type: string
        controlBehavior:
          type: integer
          enum:
          - 0
          - 1
          - 2
          - 3
          default: 0
        warmUpPeriodSec:
          type: integer
        maxQueueingTimeMs:
          type: integer
        clusterMode:
          type: boolean
          default: false