{"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:googleapis-metastore/metastore-projects-locations-services-alter-location":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_alter_location","summary":"Alter metadata resource location. The metadata resource can be a database, table, or partition. This…","description":"POST /v2/{+service}:alterLocation","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["service","body"],"properties":{"service":{"type":"string","description":"Required. The relative resource name of the metastore service to mutate metadata, in the following…"},"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:googleapis-metastore/metastore-projects-locations-services-alter-table-properties":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_alter_table_properties","summary":"Alter metadata table properties.","description":"POST /v2/{+service}:alterTableProperties","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["service","body"],"properties":{"service":{"type":"string","description":"Required. The relative resource name of the Dataproc Metastore service that's being used to mutate metadata table properties, in 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:googleapis-metastore/metastore-projects-locations-services-list":{"get":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_list","summary":"Lists services in a project and location.","description":"GET /v2/{+parent}/services","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"filter","in":"query","required":false,"description":"Optional. The filter to apply to list results.","schema":{"type":"string","description":"Optional. The filter to apply to list results."}},{"name":"orderBy","in":"query","required":false,"description":"Optional. Specify the ordering of results as described in Sorting Order…","schema":{"type":"string","description":"Optional. Specify the ordering of results as described in Sorting Order…"}},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of services to return. The response may contain less than the maximum number. If unspecified, no more than…","schema":{"type":"integer","description":"Optional. The maximum number of services to return. The response may contain less than the maximum number. If unspecified, no more than…"}},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous DataprocMetastore.ListServices call. Provide this token to retrieve the subsequent…","schema":{"type":"string","description":"Optional. A page token, received from a previous DataprocMetastore.ListServices call. Provide this token to retrieve the subsequent…"}},{"name":"parent","in":"query","required":true,"description":"Required. The relative resource name of the location of metastore services to list, in the following…","schema":{"type":"string","description":"Required. The relative resource name of the location of metastore services to list, in the following…"}}],"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:googleapis-metastore/metastore-projects-locations-services-create":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_create","summary":"Creates a metastore service in a project and location.","description":"POST /v2/{+parent}/services","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The relative resource name of the location in which to create a metastore service, in the following…"},"requestId":{"type":"string","description":"Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore…"},"serviceId":{"type":"string","description":"Required. The ID of the metastore service, which is used as the final component of the metastore service's name.This value must be between…"},"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:googleapis-metastore/metastore-projects-locations-services-backups-get":{"get":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_backups_get","summary":"Gets details of a single backup.","description":"GET /v2/{+name}","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"name","in":"query","required":true,"description":"Required. The relative resource name of the backup to retrieve, in the following…","schema":{"type":"string","description":"Required. The relative resource name of the backup to retrieve, in the following…"}}],"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:googleapis-metastore/metastore-projects-locations-services-patch":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_patch","summary":"Updates the parameters of a single service.","description":"PATCH /v2/{+name}","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Immutable. The relative resource name of the metastore service, in the following…"},"requestId":{"type":"string","description":"Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore…"},"updateMask":{"type":"string","description":"Required. A field mask used to specify the fields to be overwritten in the metastore service resource by the update. Fields specified in…"},"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:googleapis-metastore/metastore-projects-locations-services-backups-delete":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_backups_delete","summary":"Deletes a single backup.","description":"DELETE /v2/{+name}","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Required. The relative resource name of the backup to delete, in the following…"},"requestId":{"type":"string","description":"Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore…"}}}}}},"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:googleapis-metastore/metastore-projects-locations-services-export-metadata":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_export_metadata","summary":"Exports metadata from a service.","description":"POST /v2/{+service}:exportMetadata","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["service","body"],"properties":{"service":{"type":"string","description":"Required. The relative resource name of the metastore service to run export, in the following…"},"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:googleapis-metastore/metastore-projects-locations-services-import-metadata":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_import_metadata","summary":"Imports Metadata into a Dataproc Metastore service.","description":"POST /v2/{+name}:importMetadata","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Immutable. The relative resource name of the metastore service to run import, in the following…"},"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:googleapis-metastore/metastore-projects-locations-services-move-table-to-database":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_move_table_to_database","summary":"Move a table to another database.","description":"POST /v2/{+service}:moveTableToDatabase","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["service","body"],"properties":{"service":{"type":"string","description":"Required. The relative resource name of the metastore service to mutate metadata, in the following…"},"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:googleapis-metastore/metastore-projects-locations-services-query-metadata":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_query_metadata","summary":"Query Dataproc Metastore metadata.","description":"POST /v2/{+service}:queryMetadata","tags":["analytics"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["service","body"],"properties":{"service":{"type":"string","description":"Required. The relative resource name of the metastore service to query metadata, in the following…"},"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:googleapis-metastore/metastore-projects-locations-services-restore":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_restore","summary":"Restores a service from a backup.","description":"POST /v2/{+service}:restore","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["service","body"],"properties":{"service":{"type":"string","description":"Required. The relative resource name of the metastore service to run restore, in the following…"},"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:googleapis-metastore/metastore-projects-locations-services-backups-list":{"get":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_backups_list","summary":"Lists backups in a service.","description":"GET /v2/{+parent}/backups","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"filter","in":"query","required":false,"description":"Optional. The filter to apply to list results.","schema":{"type":"string","description":"Optional. The filter to apply to list results."}},{"name":"orderBy","in":"query","required":false,"description":"Optional. Specify the ordering of results as described in Sorting Order…","schema":{"type":"string","description":"Optional. Specify the ordering of results as described in Sorting Order…"}},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of backups to return. The response may contain less than the maximum number. If unspecified, no more than 500…","schema":{"type":"integer","description":"Optional. The maximum number of backups to return. The response may contain less than the maximum number. If unspecified, no more than 500…"}},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous DataprocMetastore.ListBackups call. Provide this token to retrieve the subsequent page.To…","schema":{"type":"string","description":"Optional. A page token, received from a previous DataprocMetastore.ListBackups call. Provide this token to retrieve the subsequent page.To…"}},{"name":"parent","in":"query","required":true,"description":"Required. The relative resource name of the service whose backups to list, in the following…","schema":{"type":"string","description":"Required. The relative resource name of the service whose backups to list, in the following…"}}],"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:googleapis-metastore/metastore-projects-locations-services-backups-create":{"post":{"operationId":"analytics_googleapis_metastore_metastore_projects_locations_services_backups_create","summary":"Creates a new backup in a given project and location.","description":"POST /v2/{+parent}/backups","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"backupId":{"type":"string","description":"Required. The ID of the backup, which is used as the final component of the backup's name.This value must be between 1 and 64 characters…"},"parent":{"type":"string","description":"Required. The relative resource name of the service in which to create a backup of the following…"},"requestId":{"type":"string","description":"Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore…"},"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"}}},"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"}}}}}}}