{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:tencent-cws/create-monitors":{"post":{"operationId":"cloud_tencent_cws_create_monitors","summary":"Create Monitors","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Urls","Name","ScannerType","Crontab","RateLimit","FirstScanStartTime"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"Urls":{"type":"array"},"Name":{"type":"string"},"ScannerType":{"type":"string"},"Crontab":{"type":"integer"},"RateLimit":{"type":"integer"},"FirstScanStartTime":{"type":"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:tencent-cws/create-sites":{"post":{"operationId":"cloud_tencent_cws_create_sites","summary":"Create Sites","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Urls"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"Urls":{"type":"array"},"UserAgent":{"type":"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:tencent-cws/create-sites-scans":{"post":{"operationId":"cloud_tencent_cws_create_sites_scans","summary":"Create Sites Scans","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SiteIds","ScannerType","RateLimit"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SiteIds":{"type":"array"},"ScannerType":{"type":"string"},"RateLimit":{"type":"integer"}}}}}},"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:tencent-cws/create-vuls-misinformation":{"post":{"operationId":"cloud_tencent_cws_create_vuls_misinformation","summary":"Create Vuls Misinformation","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["VulIds"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"VulIds":{"type":"array"}}}}}},"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:tencent-cws/create-vuls-report":{"post":{"operationId":"cloud_tencent_cws_create_vuls_report","summary":"Create Vuls Report","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SiteId":{"type":"integer"},"MonitorId":{"type":"integer"}}}}}},"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:tencent-cws/delete-monitors":{"post":{"operationId":"cloud_tencent_cws_delete_monitors","summary":"Delete Monitors","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MonitorIds"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"MonitorIds":{"type":"array"}}}}}},"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:tencent-cws/delete-sites":{"post":{"operationId":"cloud_tencent_cws_delete_sites","summary":"Delete Sites","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SiteIds"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SiteIds":{"type":"array"}}}}}},"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:tencent-cws/describe-config":{"post":{"operationId":"cloud_tencent_cws_describe_config","summary":"Describe Config","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"}}}}}},"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:tencent-cws/describe-monitors":{"post":{"operationId":"cloud_tencent_cws_describe_monitors","summary":"Describe Monitors","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"MonitorIds":{"type":"array"},"Filters":{"type":"array"},"Offset":{"type":"integer"},"Limit":{"type":"integer"}}}}}},"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:tencent-cws/describe-site-quota":{"post":{"operationId":"cloud_tencent_cws_describe_site_quota","summary":"Describe Site Quota","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"}}}}}},"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:tencent-cws/describe-sites":{"post":{"operationId":"cloud_tencent_cws_describe_sites","summary":"Describe Sites","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SiteIds":{"type":"array"},"Filters":{"type":"array"},"Offset":{"type":"integer"},"Limit":{"type":"integer"}}}}}},"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:tencent-cws/describe-sites-verification":{"post":{"operationId":"cloud_tencent_cws_describe_sites_verification","summary":"Describe Sites Verification","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Urls"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"Urls":{"type":"array"}}}}}},"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:tencent-cws/describe-vuls":{"post":{"operationId":"cloud_tencent_cws_describe_vuls","summary":"Describe Vuls","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SiteId":{"type":"integer"},"MonitorId":{"type":"integer"},"Filters":{"type":"array"},"Offset":{"type":"integer"},"Limit":{"type":"integer"}}}}}},"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:tencent-cws/describe-vuls-number":{"post":{"operationId":"cloud_tencent_cws_describe_vuls_number","summary":"Describe Vuls Number","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"}}}}}},"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:tencent-cws/describe-vuls-number-timeline":{"post":{"operationId":"cloud_tencent_cws_describe_vuls_number_timeline","summary":"Describe Vuls Number Timeline","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"}}}}}},"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:tencent-cws/modify-config-attribute":{"post":{"operationId":"cloud_tencent_cws_modify_config_attribute","summary":"Modify Config Attribute","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"NoticeLevel":{"type":"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:tencent-cws/modify-monitor-attribute":{"post":{"operationId":"cloud_tencent_cws_modify_monitor_attribute","summary":"Modify Monitor Attribute","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MonitorId","Urls","Name","ScannerType","Crontab","RateLimit","FirstScanStartTime","MonitorStatus"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"MonitorId":{"type":"integer"},"Urls":{"type":"array"},"Name":{"type":"string"},"ScannerType":{"type":"string"},"Crontab":{"type":"integer"},"RateLimit":{"type":"integer"},"FirstScanStartTime":{"type":"string"},"MonitorStatus":{"type":"integer"}}}}}},"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:tencent-cws/modify-site-attribute":{"post":{"operationId":"cloud_tencent_cws_modify_site_attribute","summary":"Modify Site Attribute","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SiteId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SiteId":{"type":"integer"},"Name":{"type":"string"},"NeedLogin":{"type":"integer"},"LoginCookie":{"type":"string"},"LoginCheckUrl":{"type":"string"},"LoginCheckKw":{"type":"string"},"ScanDisallow":{"type":"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:tencent-cws/verify-sites":{"post":{"operationId":"cloud_tencent_cws_verify_sites","summary":"Verify Sites","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Urls"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"Urls":{"type":"array"}}}}}},"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":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"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"}}}}}}}