> ## Documentation Index > Fetch the complete documentation index at: https://arklowdocs.io/llms.txt > Use this file to discover all available pages before exploring further. # List rules ## OpenAPI ````yaml https://api.arklow.io/swagger/ui/json get /v1/orgs/{org_id}/rules/ openapi: 3.1.0 info: title: Arklow description: Arklow's API version: 0.1.0 servers: - url: https://api.arklow.io description: Production - url: http://localhost:3123 description: Local development security: - apiKey: [] tags: - name: actions - name: api_keys - name: billing - name: config - name: credentials - name: destinations - name: invites - name: members - name: metrics - name: notifications - name: orgs - name: rules - name: sources - name: users - name: ingress externalDocs: url: https://api.arklow.io/swagger/ui paths: /v1/orgs/{org_id}/rules/: get: tags: - rules summary: List rules operationId: get_v1_orgs_by_org_id_rules parameters: - schema: type: integer minimum: 1 maximum: 50 in: query name: take required: false - schema: type: integer minimum: 0 in: query name: skip required: false - schema: anyOf: - anyOf: - type: object required: - col - op properties: col: type: string op: anyOf: - type: string enum: - eq - type: string enum: - neq - type: string enum: - starts_with - type: string enum: - contains - type: string enum: - not_contains - type: string enum: - is_null - type: string enum: - is_not_null value: type: string - type: array items: type: object required: - col - op properties: col: type: string op: anyOf: - type: string enum: - eq - type: string enum: - neq - type: string enum: - starts_with - type: string enum: - contains - type: string enum: - not_contains - type: string enum: - is_null - type: string enum: - is_not_null value: type: string - type: string in: query name: search required: false - schema: type: string in: query name: field required: false - schema: type: string in: query name: value required: false - schema: anyOf: - type: string enum: - eq - type: string enum: - neq - type: string enum: - starts_with - type: string enum: - contains - type: string enum: - not_contains - type: string enum: - is_null - type: string enum: - is_not_null in: query name: op required: false - schema: type: boolean in: query name: count_only required: false - schema: anyOf: - type: string enum: - active - type: string enum: - disabled - type: string enum: - passthrough in: query name: status required: false - schema: type: integer in: query name: priority required: false - schema: type: string in: query name: phase required: false - schema: anyOf: - type: string enum: - dispatch - type: string enum: - skip - type: string enum: - terminate - type: string enum: - assign_tags in: query name: effect required: false - schema: type: string pattern: ^[0-9]+$ in: query name: action_definition_id required: false - schema: type: boolean in: query name: include_action_definition required: false - schema: type: string pattern: ^[0-9]+$ in: path name: org_id required: true responses: '200': description: Default Response content: application/json: schema: type: object required: - data - errors properties: data: anyOf: - type: object required: - items - count properties: items: type: array items: type: object required: - id - org_id - name - status - expression - priority - phase - effect - action_definition_id - updated_at properties: id: type: string org_id: type: string name: type: string status: anyOf: - type: string enum: - active - type: string enum: - disabled - type: string enum: - passthrough expression: type: string priority: type: integer phase: type: string effect: anyOf: - type: string enum: - dispatch - type: string enum: - skip - type: string enum: - terminate - type: string enum: - assign_tags effect_payload: {} action_definition_id: type: string updated_at: type: string format: date-time deleted_at: anyOf: - type: 'null' - type: string format: date-time action_definition: type: object required: - id - org_id - variant - version - alias - schema properties: id: type: string org_id: type: string variant: type: string version: type: integer alias: type: array items: type: string schema: {} deleted_at: anyOf: - type: 'null' - type: string format: date-time destinations: type: array items: type: object required: - id - action_definition_id - destination_id - org_id properties: id: type: string action_definition_id: type: string destination_id: type: string org_id: type: string is_default: type: boolean destination: allOf: - type: object required: - id - org_id - updated_at properties: id: type: string org_id: type: string updated_at: type: string format: date-time deleted_at: anyOf: - type: 'null' - type: string format: date-time - type: object required: - label properties: label: type: string - type: object properties: tags: anyOf: - type: object additionalProperties: type: string - type: 'null' - type: object properties: credential_id: anyOf: - type: string pattern: ^[0-9]+$ - type: 'null' - anyOf: - type: object required: - type - config properties: type: type: string enum: - webhook config: type: object required: - url properties: url: type: string format: uri headers: type: object additionalProperties: type: string signaling: anyOf: - type: object required: - enabled - default properties: enabled: type: boolean enum: - true default: anyOf: - type: {} enum: {} - type: {} enum: {} additionalProperties: false - type: object required: - enabled properties: enabled: type: boolean enum: - false default: anyOf: - type: {} enum: {} - type: {} enum: {} additionalProperties: false response_time_sla_ms: type: integer minimum: 1 additionalProperties: false - type: object required: - type - config properties: type: type: string enum: - sdk config: type: object required: - namespace properties: namespace: type: string signaling: anyOf: - type: object required: - enabled - default properties: enabled: type: boolean enum: - true default: anyOf: - type: {} enum: {} - type: {} enum: {} additionalProperties: false - type: object required: - enabled properties: enabled: type: boolean enum: - false default: anyOf: - type: {} enum: {} - type: {} enum: {} additionalProperties: false response_time_sla_ms: type: integer minimum: 1 additionalProperties: false - type: object required: - type - config properties: type: type: string enum: - google_pubsub config: type: object required: - project_id - topic_id properties: project_id: type: string topic_id: type: string response_time_sla_ms: type: integer minimum: 1 - type: object required: - type - config properties: type: type: string enum: - aws_sqs config: type: object required: - queue_url properties: queue_url: type: string format: uri region: type: string response_time_sla_ms: type: integer minimum: 1 - type: object required: - type - config properties: type: type: string enum: - mcp config: type: object required: - endpoint properties: endpoint: type: string format: uri response_time_sla_ms: type: integer minimum: 1 - type: object required: - type - config properties: type: type: string enum: - default_sink config: type: object properties: {} additionalProperties: false count: type: integer - type: 'null' errors: anyOf: - type: array items: type: object required: - code - message properties: code: type: string message: type: string - type: 'null' components: securitySchemes: apiKey: type: apiKey name: x-arklow-auth in: header ````