Aikido Security Custom Rules API

openapi: 3.1.0
info:
  title: Aikido Security Public REST Clouds Custom Rules API
  version: '1.0'
  description: 'Best-effort OpenAPI 3.1 representation of the Aikido Security public REST API

    derived from https://apidocs.aikido.dev/ (llms.txt index and reference pages).

    Aikido is an all-in-one application security platform exposing endpoints for

    issues, code repositories, containers, clouds, domains, compliance, teams,

    users, webhooks, Zen app protection, and more.

    '
  contact:
    name: Aikido Security
    url: https://apidocs.aikido.dev/
servers:
- url: https://app.aikido.dev/api/public/v1
  description: EU (default) region
- url: https://app.us.aikido.dev/api/public/v1
  description: US region
- url: https://app.me.aikido.dev/api/public/v1
  description: Middle East region
security:
- BearerAuth: []
tags:
- name: Custom Rules
paths:
  /custom-rules:
    get:
      tags:
      - Custom Rules
      summary: List custom Semgrep rules
      operationId: listCustomRules
      responses:
        '200':
          description: OK
    post:
      tags:
      - Custom Rules
      summary: Create custom Semgrep rule
      operationId: createCustomRule
      responses:
        '201':
          description: Created
  /custom-rules/{id}:
    get:
      tags:
      - Custom Rules
      summary: Get custom rule
      operationId: getCustomRule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
    delete:
      tags:
      - Custom Rules
      summary: Remove custom rule
      operationId: removeCustomRule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Removed
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Bearer access token obtained via POST https://app.aikido.dev/api/oauth/token

        with grant_type=client_credentials and Basic auth (client_id:client_secret).

        '