> ## 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 workspace ID

> Query the workspace ID and recommended rule templates by workspace name and environment.
No authentication required; used by integration platforms to query configuration.




## OpenAPI

````yaml /openapi/pawsql-integration-en.yaml get /sql-audits/workspace-lookup
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/workspace-lookup:
    get:
      tags:
        - SQL Audit Tasks
      summary: Query workspace ID
      description: >
        Query the workspace ID and recommended rule templates by workspace name
        and environment.

        No authentication required; used by integration platforms to query
        configuration.
      operationId: lookupWorkspace
      parameters:
        - name: name
          in: query
          required: true
          schema:
            type: string
          description: Workspace name
          example: my-workspace
        - name: env
          in: query
          required: false
          schema:
            type: string
          description: Environment identifier (optional)
          example: production
      responses:
        '200':
          description: Workspace lookup result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceLookupResult'
              example:
                code: 200
                message: Success
                data:
                  workspaceId: '1730411624641736706'
                  workspaceName: my-workspace
                  env: production
                  dbType: mysql
                  orgId: '1'
                  recommendedDbObjectRuleTemplateId: '100'
                  recommendedAuditRuleTemplateId: '200'
components:
  schemas:
    WorkspaceLookupResult:
      type: object
      description: Workspace lookup result
      properties:
        workspaceId:
          type: string
          description: Workspace ID
          example: '1730411624641736706'
        workspaceName:
          type: string
          description: Workspace name
        env:
          type: string
          description: Environment identifier
        dbType:
          type: string
          description: Database type (displayCode)
          example: mysql
        orgId:
          type: string
          description: Owning organization ID
        recommendedDbObjectRuleTemplateId:
          type: string
          description: >-
            Recommended inspection rule template ID (global template
            auto-matched by database type, 0 indicates the default template)
        recommendedAuditRuleTemplateId:
          type: string
          description: >-
            Recommended audit rule template ID (global template auto-matched by
            database type, 0 indicates the default template)

````