openapi: 3.1.0
info:
  title: Kion Cloud Operations Accounts Compliance Checks API
  description: The Kion Public API provides programmatic access to manage cloud operations, governance, compliance, and financial management across AWS, Azure, GCP, and OCI. Kion is a self-hosted cloud operations platform that consolidates account provisioning, access management, compliance enforcement, and FinOps into a single interface. The API uses Bearer token authentication via Kion App API Keys and is accessible at the /api/v3/ path of your Kion instance.
  version: 3.10.0
  contact:
    name: Kion Support
    url: https://support.kion.io
  license:
    name: Proprietary
    url: https://kion.io/why-kion/pricing-and-licensing/
servers:
- url: https://{kion-instance}/api/v3
  description: Kion Instance API Server
  variables:
    kion-instance:
      default: your-kion-instance.example.com
      description: Your Kion deployment hostname
security:
- bearerAuth: []
tags:
- name: Compliance Checks
  description: Manage compliance checks for auditing cloud resources
paths:
  /compliance-check:
    get:
      operationId: listComplianceChecks
      summary: Kion List compliance checks
      description: Returns a list of all compliance checks.
      tags:
      - Compliance Checks
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ComplianceCheck'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createComplianceCheck
      summary: Kion Create a compliance check
      description: Creates a new compliance check.
      tags:
      - Compliance Checks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceCheckCreate'
      responses:
        '201':
          description: Compliance check created
        '401':
          $ref: '#/components/responses/Unauthorized'
  /compliance-check/{id}:
    get:
      operationId: getComplianceCheck
      summary: Kion Get a compliance check
      description: Returns details for a specific compliance check.
      tags:
      - Compliance Checks
      parameters:
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  data:
                    $ref: '#/components/schemas/ComplianceCheck'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateComplianceCheck
      summary: Kion Update a compliance check
      description: Updates an existing compliance check.
      tags:
      - Compliance Checks
      parameters:
      - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceCheckUpdate'
      responses:
        '200':
          description: Compliance check updated
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteComplianceCheck
      summary: Kion Delete a compliance check
      description: Deletes a compliance check.
      tags:
      - Compliance Checks
      parameters:
      - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Compliance check deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Authentication failed or API key is missing/invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: integer
                example: 401
              message:
                type: string
                example: Unauthorized
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: integer
                example: 404
              message:
                type: string
                example: Not found
  schemas:
    ComplianceCheck:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        cloud_provider_id:
          type: integer
        compliance_check_type_id:
          type: integer
        severity_type_id:
          type: integer
        body:
          type: string
          description: The compliance check policy body
        frequency_minutes:
          type: integer
        frequency_type_id:
          type: integer
        is_all_regions:
          type: boolean
        is_auto_archived:
          type: boolean
        regions:
          type: array
          items:
            type: string
        owner_users:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
        owner_user_groups:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
        labels:
          type: object
          additionalProperties:
            type: string
        created_at:
          type: string
          format: date-time
    ComplianceCheckCreate:
      type: object
      required:
      - name
      - cloud_provider_id
      - compliance_check_type_id
      properties:
        name:
          type: string
        description:
          type: string
        cloud_provider_id:
          type: integer
        compliance_check_type_id:
          type: integer
        severity_type_id:
          type: integer
        body:
          type: string
        frequency_minutes:
          type: integer
        frequency_type_id:
          type: integer
        is_all_regions:
          type: boolean
        is_auto_archived:
          type: boolean
        regions:
          type: array
          items:
            type: string
        labels:
          type: object
          additionalProperties:
            type: string
    ComplianceCheckUpdate:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        severity_type_id:
          type: integer
        body:
          type: string
        frequency_minutes:
          type: integer
        is_all_regions:
          type: boolean
        is_auto_archived:
          type: boolean
        regions:
          type: array
          items:
            type: string
        labels:
          type: object
          additionalProperties:
            type: string
  parameters:
    IdParam:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource in Kion
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Kion App API Key. Generate in Kion under your user profile settings. Use in the Authorization header as: Bearer YOUR_API_KEY'