{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-codesec/complete-code-bundle":{"post":{"operationId":"cloud_aliyun_codesec_complete_code_bundle","summary":"Finalizes a code bundle after the client completes an OSS PUT operation. This operation validates the…","description":"POST /v1/projects/{projectId}/codeBundles/{codeBundleId}/complete","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","codeBundleId","byteSize","contentType"],"properties":{"endpoint":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"},"projectId":{"type":"string","description":"The project ID"},"codeBundleId":{"type":"string","description":"The code bundle ID"},"byteSize":{"type":"integer","description":"The declared size of the uploaded object. This value must match the OSS Content-Length"},"contentType":{"type":"string","description":"The MIME type of the stored code bundle. This is typically application/octet-stream for pre-signed PUT operations"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-codesec/create-code-bundle":{"post":{"operationId":"cloud_aliyun_codesec_create_code_bundle","summary":"Creates a function code package in pending status and returns a pre-signed OSS PUT upload credential","description":"POST /v1/projects/{projectId}/codeBundles","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","filename"],"properties":{"endpoint":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"},"projectId":{"type":"string","description":"The project ID"},"filename":{"type":"string","description":"The file name"},"ciMetadata":{"type":"string","description":"An optional CI/CD metadata JSON string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-codesec/create-project":{"post":{"operationId":"cloud_aliyun_codesec_create_project","summary":"Creates a project","description":"POST /v1/projects","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"endpoint":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"},"name":{"type":"string","description":"The project name"},"description":{"type":"string","description":"The description"},"instructionPrompt":{"type":"string","description":"The natural language prompt that describes scanning or result processing preferences, such as ignoring low-risk vulnerabilities"},"source":{"type":"string","description":"The project source (JSON-encoded)"},"engines":{"type":"string","description":"The engine switches for the project or scan snapshot. Only SAST and SCA are supported (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-codesec/create-scan":{"post":{"operationId":"cloud_aliyun_codesec_create_scan","summary":"Creates a scan task based on a code package that is ready","description":"POST /v1/projects/{projectId}/scans","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","kind","codeBundleId","taskName"],"properties":{"endpoint":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"},"projectId":{"type":"string","description":"The project ID"},"kind":{"type":"string","enum":["full","incremental"],"description":"The type. Valid values: full: full data incremental: incremental"},"codeBundleId":{"type":"integer","description":"The code package ID"},"taskName":{"type":"string","description":"The task name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-codesec/create-scan-sbom-export":{"post":{"operationId":"cloud_aliyun_codesec_create_scan_sbom_export","summary":"Generates a download link for an SBOM or license manifest that includes producer metadata","description":"POST /v1/projects/{projectId}/scans/{scanId}/reports/sbomExports","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","scanId","format"],"properties":{"endpoint":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"},"projectId":{"type":"string","description":"The project ID"},"scanId":{"type":"string","description":"The task ID"},"format":{"type":"string","enum":["cyclonedx-json","spdx-json","licenses-json","licenses-csv"],"description":"Valid values: cyclonedx-json spdx-json"},"fileName":{"type":"string","description":"The file name (including the extension) for the downloaded file. The file name is signed into the Content-Disposition header of the URL.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-codesec/describe-projects":{"get":{"operationId":"cloud_aliyun_codesec_describe_projects","summary":"Lists projects under a tenant by page, with support for fuzzy search by name or prompt","description":"GET /v1/projects","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"}},{"name":"maxResults","in":"query","required":false,"description":"The number of entries per page. Default value: 10. Maximum value: 20","schema":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 20"},"example":"20"},{"name":"nextToken","in":"query","required":false,"description":"The pagination token. Do not specify this parameter or set it to an empty string for the first page. For subsequent pages, pass the…","schema":{"type":"string","description":"The pagination token. Do not specify this parameter or set it to an empty string for the first page. For subsequent pages, pass the…"},"example":"eyJ0IjoiMjAyNi0wNy0xNlQwNzo1MzozOC4wMjFaIiwiaSI6MTAwMDQ0OH0"},{"name":"query","in":"query","required":false,"description":"The keyword used for fuzzy match by project name or prompt","schema":{"type":"string","description":"The keyword used for fuzzy match by project name or prompt"},"example":"project"},{"name":"sortBy","in":"query","required":false,"description":"The field by which to sort the results. Default value: last_scan_time. Valid values: last_scan_time: the time when a task was last…","schema":{"type":"string","enum":["updatedAt","createdAt","lastScanTime"],"description":"The field by which to sort the results. Default value: last_scan_time. Valid values: last_scan_time: the time when a task was last…"},"example":"last_scan_time"},{"name":"sortOrder","in":"query","required":false,"description":"The sort order. Default value: desc. Valid values: desc: descending order. asc: ascending order","schema":{"type":"string","enum":["asc","desc"],"description":"The sort order. Default value: desc. Valid values: desc: descending order. asc: ascending order"},"example":"desc"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-codesec/describe-scan":{"get":{"operationId":"cloud_aliyun_codesec_describe_scan","summary":"Queries the details of a scan task","description":"GET /v1/projects/{projectId}/scans/{scanId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"}},{"name":"projectId","in":"query","required":true,"description":"The project ID","schema":{"type":"string","description":"The project ID"}},{"name":"scanId","in":"query","required":true,"description":"The task ID","schema":{"type":"string","description":"The task ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-codesec/describe-scan-results-by-engine":{"get":{"operationId":"cloud_aliyun_codesec_describe_scan_results_by_engine","summary":"Queries the task result list to retrieve detailed SAST or SCA results of a specific scan","description":"GET /v1/projects/{projectId}/scans/{scanId}/results/{engine}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"}},{"name":"projectId","in":"query","required":true,"description":"The project ID","schema":{"type":"string","description":"The project ID"}},{"name":"scanId","in":"query","required":true,"description":"The task ID","schema":{"type":"string","description":"The task ID"}},{"name":"engine","in":"query","required":true,"description":"The engine type. Valid values: sast sca","schema":{"type":"string","description":"The engine type. Valid values: sast sca"}},{"name":"nextToken","in":"query","required":false,"description":"The pagination token. Do not specify this parameter for the first page or set it to an empty string. For subsequent pages, pass the…","schema":{"type":"string","description":"The pagination token. Do not specify this parameter for the first page or set it to an empty string. For subsequent pages, pass the…"},"example":"eyJ0IjoiMjAyNi0wNy0xNlQwNzo1MzozOC4wMjFaIiwiaSI6MTAwMDQ0OH0"},{"name":"maxResults","in":"query","required":false,"description":"The number of entries per page. Default value: 10. Maximum value: 50","schema":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 50"},"example":"50"},{"name":"baselineState","in":"query","required":false,"description":"Filters results by the baseline state of incremental scans. Valid values: new, unchanged, absent, and updated","schema":{"type":"string","enum":["new","unchanged","absent","updated"],"description":"Filters results by the baseline state of incremental scans. Valid values: new, unchanged, absent, and updated"},"example":"unchanged"},{"name":"packageName","in":"query","required":false,"description":"The component name for fuzzy match. This parameter takes effect only when engine is set to sca","schema":{"type":"string","description":"The component name for fuzzy match. This parameter takes effect only when engine is set to sca"},"example":"app10000006824_fulljoin_61b2c_global_ad_budget_ctrl_v1.5.jar"},{"name":"lang","in":"query","required":false,"description":"The language. Valid values: zh: Chinese (default). en: English","schema":{"type":"string","description":"The language. Valid values: zh: Chinese (default). en: English"},"example":"zh"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-codesec/describe-scans":{"get":{"operationId":"cloud_aliyun_codesec_describe_scans","summary":"Queries the scan tasks of a specific project in a paginated manner","description":"GET /v1/projects/{projectId}/scans","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"}},{"name":"projectId","in":"query","required":true,"description":"The project ID","schema":{"type":"string","description":"The project ID"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of entries per page. Default value: 20. Maximum value: 100","schema":{"type":"integer","description":"The maximum number of entries per page. Default value: 20. Maximum value: 100"},"example":"10"},{"name":"nextToken","in":"query","required":false,"description":"The pagination token. To query the first page, leave this parameter empty or do not specify it. To query subsequent pages, pass the…","schema":{"type":"string","description":"The pagination token. To query the first page, leave this parameter empty or do not specify it. To query subsequent pages, pass the…"},"example":"eyJ0IjoiMjAyNi0wNy0xNlQwNzo1MzozOC4wMjFaIiwiaSI6MTAwMDQ0OH0"},{"name":"status","in":"query","required":false,"description":"The status of the task. Valid values: running: The task is running. completed: The task is completed. failed: The task failed","schema":{"type":"string","description":"The status of the task. Valid values: running: The task is running. completed: The task is completed. failed: The task failed"},"example":"completed"},{"name":"taskName","in":"query","required":false,"description":"The name of the task","schema":{"type":"string","description":"The name of the task"},"example":"name"},{"name":"query","in":"query","required":false,"description":"The query string. You can perform a fuzzy match by project name or prompt","schema":{"type":"string","description":"The query string. You can perform a fuzzy match by project name or prompt"},"example":"name"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-codesec/version":{"post":{"operationId":"cloud_aliyun_codesec_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://codesec.ap-southeast-1.aliyuncs.com","https://codesec.cn-hangzhou.aliyuncs.com"],"default":"https://codesec.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://codesec.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}