{"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/analytics:microsoft-fabric-sql-database/items-list-sqldatabases":{"get":{"operationId":"analytics_microsoft_fabric_sql_database_items_list_sqldatabases","summary":"Returns a list of SQL databases from the specified workspace.","description":"GET /workspaces/{workspaceId}/sqlDatabases","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"recursive","in":"query","required":false,"description":"Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed,…","schema":{"type":"boolean","description":"Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed,…"}},{"name":"rootFolderId","in":"query","required":false,"description":"This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.","schema":{"type":"string","description":"This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder."}},{"name":"continuationToken","in":"query","required":false,"description":"A token for retrieving the next page of results.","schema":{"type":"string","description":"A token for retrieving the next page of results."}}],"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/analytics:microsoft-fabric-sql-database/items-create-sqldatabase":{"post":{"operationId":"analytics_microsoft_fabric_sql_database_items_create_sqldatabase","summary":"Creates a SQL database in the specified workspace.","description":"POST /workspaces/{workspaceId}/sqlDatabases","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"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/analytics:microsoft-fabric-sql-database/items-get-sqldatabase":{"get":{"operationId":"analytics_microsoft_fabric_sql_database_items_get_sqldatabase","summary":"Returns properties of the specified SQL database.","description":"GET /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"sqlDatabaseId","in":"query","required":true,"description":"The SQL database ID.","schema":{"type":"string","description":"The SQL database 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/analytics:microsoft-fabric-sql-database/items-update-sqldatabase":{"post":{"operationId":"analytics_microsoft_fabric_sql_database_items_update_sqldatabase","summary":"Updates the properties of the specified SQL database.","description":"PATCH /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sqlDatabaseId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"sqlDatabaseId":{"type":"string","description":"The SQL database ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"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/analytics:microsoft-fabric-sql-database/items-delete-sqldatabase":{"post":{"operationId":"analytics_microsoft_fabric_sql_database_items_delete_sqldatabase","summary":"Deletes the specified SQL database.","description":"DELETE /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sqlDatabaseId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"sqlDatabaseId":{"type":"string","description":"The SQL database ID."},"hardDelete":{"type":"boolean","description":"Specifies whether to perform a hard delete. When set to `true`, the item is permanently deleted and cannot be recovered. When set to…"}}}}}},"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/analytics:microsoft-fabric-sql-database/items-get-sqldatabase-definition":{"post":{"operationId":"analytics_microsoft_fabric_sql_database_items_get_sqldatabase_definition","summary":"Returns the specified SQL database public definition.","description":"POST /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sqlDatabaseId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"sqlDatabaseId":{"type":"string","description":"The SQL database ID."},"format":{"type":"string","description":"The format of the SQL database public definition. Supported format: `dacpac` and `sqlproj`. If no format is provided, `dacpac` is used."}}}}}},"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/analytics:microsoft-fabric-sql-database/items-update-sqldatabase-definition":{"post":{"operationId":"analytics_microsoft_fabric_sql_database_items_update_sqldatabase_definition","summary":"Overrides the definition for the specified SQL database.","description":"POST /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/updateDefinition","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sqlDatabaseId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"sqlDatabaseId":{"type":"string","description":"The SQL database ID."},"updateMetadata":{"type":"boolean","description":"When set to true and the SQL database.platform file is provided as part of the definition, the item's metadata is updated using the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"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/analytics:microsoft-fabric-sql-database/mirroring-start-mirroring":{"post":{"operationId":"analytics_microsoft_fabric_sql_database_mirroring_start_mirroring","summary":"Starts the mirroring of the specified SQL database..","description":"POST /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/startMirroring","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sqlDatabaseId"],"properties":{"workspaceId":{"type":"string","description":"The workspace identifier."},"sqlDatabaseId":{"type":"string","description":"The SQL database 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-sql-database/mirroring-stop-mirroring":{"post":{"operationId":"analytics_microsoft_fabric_sql_database_mirroring_stop_mirroring","summary":"Stops the mirroring of the specified SQL database.","description":"POST /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/stopMirroring","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sqlDatabaseId"],"properties":{"workspaceId":{"type":"string","description":"The workspace identifier."},"sqlDatabaseId":{"type":"string","description":"The SQL database 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-sql-database/items-revalidate-cmk":{"post":{"operationId":"analytics_microsoft_fabric_sql_database_items_revalidate_cmk","summary":"Revalidate Customer‑Managed Key (CMK) of the specified SQL database.","description":"POST /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/revalidateCMK","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sqlDatabaseId"],"properties":{"workspaceId":{"type":"string","description":"The workspace identifier."},"sqlDatabaseId":{"type":"string","description":"The SQL database 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-sql-database/sqlaudit-settings-get-sqlaudit-settings":{"get":{"operationId":"analytics_microsoft_fabric_sql_database_sqlaudit_settings_get_sqlaudit_settings","summary":"Gets the auditing settings on the specified SQL database.","description":"GET /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/settings/sqlAudit","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace identifier.","schema":{"type":"string","description":"The workspace identifier."}},{"name":"sqlDatabaseId","in":"query","required":true,"description":"The SQL database ID.","schema":{"type":"string","description":"The SQL database 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/analytics:microsoft-fabric-sql-database/sqlaudit-settings-update-sqlaudit-settings":{"post":{"operationId":"analytics_microsoft_fabric_sql_database_sqlaudit_settings_update_sqlaudit_settings","summary":"Updates the auditing settings on the specified SQL database.","description":"PATCH /workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/settings/sqlAudit","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sqlDatabaseId"],"properties":{"workspaceId":{"type":"string","description":"The workspace identifier."},"sqlDatabaseId":{"type":"string","description":"The SQL database ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"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/analytics:microsoft-fabric-sql-database/items-list-restorable-deleted-databases":{"get":{"operationId":"analytics_microsoft_fabric_sql_database_items_list_restorable_deleted_databases","summary":"Gets the list of restorable deleted databases in the workspace.","description":"GET /workspaces/{workspaceId}/sqlDatabases/restorableDeletedDatabases","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace identifier.","schema":{"type":"string","description":"The workspace identifier."}},{"name":"recursive","in":"query","required":false,"description":"Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed,…","schema":{"type":"boolean","description":"Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed,…"}},{"name":"rootFolderId","in":"query","required":false,"description":"This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.","schema":{"type":"string","description":"This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder."}}],"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"}}},"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"}}}}}}}