> ## Documentation Index > Fetch the complete documentation index at: https://docs.pawsql.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > PawSQL 是一个产品：Cloud 是公网部署形态，Engine / Optimizer / Auditor / Advisor / Patroller 是同一产品的组件与交付形态，不是彼此独立的产品。 / PawSQL is a single product: Cloud is the public deployment form, while Engine / Optimizer / Auditor / Advisor / Patroller are components and delivery forms of the same product, not separate products. > 术语以站内术语表为准：SQL 审核对应英文 SQL Review，查询重写对应 Query Rewrite，索引推荐对应 Index Recommendation；英文内容统一用 Review，不用 Audit。 / Use the site glossary for terminology: 审核 is SQL Review, 重写 is Query Rewrite, 索引推荐 is Index Recommendation; English content uses Review, never Audit. > 引用能力范围或版本支持时以对应页面为准；标注 unknown、或 status 非 published 的内容表示尚未经产品核实，不应作为事实引用。 / Cite capability scope and version support from the corresponding page; content marked unknown, or with a status other than published, is not yet product-verified and must not be cited as fact. # Query audit result > Query the status and result of a SQL audit task by task ID. ## OpenAPI ````yaml /openapi/pawsql-integration-en.yaml get /sql-audits/{taskId} openapi: 3.0.3 info: title: CI/CD Integration description: > CI/CD Integration APIs for external platforms (BlueKing, Coding, GitLab, etc.) to integrate SQL audit capabilities. ## Endpoint Categories - **SQL Audit Tasks**: create audit tasks, query audit results, look up workspaces - **Webhook Callbacks**: receive code change events pushed by GitLab/Coding/GitHub platforms to automatically trigger SQL audits ## Authentication SQL audit task endpoints do not require a userKey; the source platform is identified by `platformCode`. Webhook endpoints are verified through the `webhookToken` in the URL. ## Typical Integration Flow 1. Create a workspace and audit rule template in the PawSQL admin console 2. Call `/sql-audits/workspace-lookup` to look up the workspaceId and ruleTemplateId 3. Call `POST /sql-audits` to create an audit task (passing SQL text or code change info) 4. Poll `GET /sql-audits/{taskId}` for the audit result 5. Or configure a Webhook to trigger audits automatically on code push version: 1.0.0 contact: name: PawSQL Team url: https://pawsql.com license: name: PawSQL url: https://pawsql.com servers: - url: /api/v1 description: PawSQL Server security: [] tags: - name: SQL Audit Tasks description: Creation and query of SQL audit tasks - name: GitLab Webhook description: GitLab Webhook callback - name: Coding Webhook description: Coding Webhook callback - name: GitHub Webhook description: GitHub Webhook callback paths: /sql-audits/{taskId}: get: tags: - SQL Audit Tasks summary: Query audit result description: Query the status and result of a SQL audit task by task ID. operationId: getSqlAuditTask parameters: - name: taskId in: path required: true schema: type: string description: Audit task ID example: audit-001 responses: '200': description: Audit task details content: application/json: schema: $ref: '#/components/schemas/SqlAuditTaskRead' examples: finished: summary: Audit finished value: code: 200 message: Success data: taskId: audit-001 status: finished result: allow riskLevel: 2 riskLevelDesc: notice summary: |- ## Audit Result - Total SQL: 1 - Violations: 0 - Risk level: notice reportUrl: https://pawsql.com/report/audit-001 running: summary: Audit in progress value: code: 200 message: Success data: taskId: audit-001 status: running result: null components: schemas: SqlAuditTaskRead: type: object description: SQL audit task response properties: taskId: type: string description: Task ID requestId: type: string description: Idempotency key (external request ID) status: type: string description: 'Task status: accepted/running/finished' enum: - accepted - running - finished result: type: string description: 'Decision result: allow/deny/timeout/failed' enum: - allow - deny - timeout - failed errorCode: type: integer description: Error code (only present when result=failed) errorMessage: type: string description: Error message (only present when result=failed) riskLevel: type: integer description: 'Risk level: 0-critical 1-warning 2-notice' enum: - 0 - 1 - 2 riskLevelDesc: type: string description: 'Risk level description: critical/warning/notice' enum: - critical - warning - notice statistics: type: object additionalProperties: true description: Statistics information summary: type: string description: Audit summary (Markdown format, suitable for display) summaryData: $ref: '#/components/schemas/SummaryData' reportUrl: type: string description: Report detail page URL reportHtml: type: string description: Report HTML content callbackStatus: type: string description: 'Callback status: pending/success/failed/skipped' callbackMessage: type: string description: Callback result message finishedAt: type: string format: date-time description: Completion time extra: type: object additionalProperties: true description: Extended data (passed through) ticketId: type: string description: Associated ticket ID ticketTitle: type: string description: Ticket title (usable for platform search) auditId: type: string description: Associated audit ID workspaceInfo: $ref: '#/components/schemas/WorkspaceInfo' env: type: string description: Environment information orgInfo: $ref: '#/components/schemas/OrgInfo' ruleTemplateInfo: $ref: '#/components/schemas/RuleTemplateInfo' operatorEmail: type: string description: Operator email enableIndexRecommendation: type: boolean description: Whether to run index recommendation SummaryData: type: object description: Audit summary (structured JSON, suitable for metrics analysis) properties: result: type: string description: 'Audit result: allow/deny/timeout/failed' riskLevel: type: integer description: 'Risk level: 0-critical 1-warning 2-notice' riskLevelDesc: type: string description: 'Risk level description: critical/warning/notice' sqlTotal: type: integer description: Total number of SQL statements violationCount: type: integer description: Number of violating SQL statements levelStats: $ref: '#/components/schemas/LevelStats' files: type: array items: type: string description: List of audited files violations: type: array items: $ref: '#/components/schemas/ViolationItem' description: List of violating SQL statements WorkspaceInfo: type: object description: Workspace information properties: id: type: string description: Workspace ID name: type: string description: Workspace name OrgInfo: type: object description: Organization information properties: id: type: string description: Organization ID name: type: string description: Organization name code: type: string description: Organization code RuleTemplateInfo: type: object description: Rule template information properties: id: type: string description: Template ID name: type: string description: Template name LevelStats: type: object description: Problem count by level properties: critical: type: integer description: Number of critical-level problems warning: type: integer description: Number of warning-level problems notice: type: integer description: Number of notice-level problems ViolationItem: type: object description: Violating SQL entry properties: sourceFile: type: string description: Source file path lineNumber: type: integer description: Line number (may be null) sql: type: string description: SQL snippet (max 300 characters) rules: type: array items: $ref: '#/components/schemas/RuleRef' description: List of violated rules RuleRef: type: object description: Rule reference properties: level: type: string description: 'Rule level: critical/warning/notice' enum: - critical - warning - notice ruleName: type: string description: Rule name ````