{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:confluent-data-catalog-v1/get-all-business-metadata-defs":{"get":{"operationId":"cloud_confluent_data_catalog_v1_get_all_business_metadata_defs","summary":"Bulk Read Business Metadata Definitions","description":"GET /catalog/v1/types/businessmetadatadefs","tags":["cloud"],"parameters":[{"name":"prefix","in":"query","required":false,"description":"The prefix of a business metadata definition name","schema":{"type":"string","description":"The prefix of a business metadata definition 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:confluent-data-catalog-v1/create-business-metadata-defs":{"post":{"operationId":"cloud_confluent_data_catalog_v1_create_business_metadata_defs","summary":"Bulk Create Business Metadata Definitions","description":"POST /catalog/v1/types/businessmetadatadefs","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/cloud:confluent-data-catalog-v1/update-business-metadata-defs":{"post":{"operationId":"cloud_confluent_data_catalog_v1_update_business_metadata_defs","summary":"Bulk Update Business Metadata Definitions","description":"PUT /catalog/v1/types/businessmetadatadefs","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/cloud:confluent-data-catalog-v1/get-business-metadata-def-by-name":{"get":{"operationId":"cloud_confluent_data_catalog_v1_get_business_metadata_def_by_name","summary":"Read Business Metadata Definition","description":"GET /catalog/v1/types/businessmetadatadefs/{bmName}","tags":["cloud"],"parameters":[{"name":"bmName","in":"query","required":true,"description":"The name of the business metadata definition","schema":{"type":"string","description":"The name of the business metadata definition"}}],"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:confluent-data-catalog-v1/delete-business-metadata-def":{"post":{"operationId":"cloud_confluent_data_catalog_v1_delete_business_metadata_def","summary":"Delete Business Metadata Definition","description":"DELETE /catalog/v1/types/businessmetadatadefs/{bmName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bmName"],"properties":{"bmName":{"type":"string","description":"The name of the business metadata definition"}}}}}},"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:confluent-data-catalog-v1/create-business-metadata":{"post":{"operationId":"cloud_confluent_data_catalog_v1_create_business_metadata","summary":"Bulk Create Business Metadata","description":"POST /catalog/v1/entity/businessmetadata","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/cloud:confluent-data-catalog-v1/update-business-metadata":{"post":{"operationId":"cloud_confluent_data_catalog_v1_update_business_metadata","summary":"Bulk Update Business Metadata","description":"PUT /catalog/v1/entity/businessmetadata","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/cloud:confluent-data-catalog-v1/get-business-metadata":{"get":{"operationId":"cloud_confluent_data_catalog_v1_get_business_metadata","summary":"Read Business Metadata for an Entity","description":"GET /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata","tags":["cloud"],"parameters":[{"name":"typeName","in":"query","required":true,"description":"The type of the entity","schema":{"type":"string","description":"The type of the entity"}},{"name":"qualifiedName","in":"query","required":true,"description":"The qualified name of the entity","schema":{"type":"string","description":"The qualified name of the entity"}}],"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:confluent-data-catalog-v1/delete-business-metadata":{"post":{"operationId":"cloud_confluent_data_catalog_v1_delete_business_metadata","summary":"Delete a Business Metadata for an Entity","description":"DELETE /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["typeName","qualifiedName","bmName"],"properties":{"typeName":{"type":"string","description":"The type of the entity"},"qualifiedName":{"type":"string","description":"The qualified name of the entity"},"bmName":{"type":"string","description":"The name of the business metadata"}}}}}},"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:confluent-data-catalog-v1/create-tags":{"post":{"operationId":"cloud_confluent_data_catalog_v1_create_tags","summary":"Bulk Create Tags","description":"POST /catalog/v1/entity/tags","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/cloud:confluent-data-catalog-v1/update-tags":{"post":{"operationId":"cloud_confluent_data_catalog_v1_update_tags","summary":"Bulk Update Tags","description":"PUT /catalog/v1/entity/tags","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/cloud:confluent-data-catalog-v1/get-by-unique-attributes":{"get":{"operationId":"cloud_confluent_data_catalog_v1_get_by_unique_attributes","summary":"Read an Entity","description":"GET /catalog/v1/entity/type/{typeName}/name/{qualifiedName}","tags":["cloud"],"parameters":[{"name":"typeName","in":"query","required":true,"description":"The type of the entity","schema":{"type":"string","description":"The type of the entity"}},{"name":"qualifiedName","in":"query","required":true,"description":"The qualified name of the entity","schema":{"type":"string","description":"The qualified name of the entity"}},{"name":"minExtInfo","in":"query","required":false,"description":"Whether to populate on header and schema attributes","schema":{"type":"boolean","default":false,"description":"Whether to populate on header and schema attributes"}},{"name":"ignoreRelationships","in":"query","required":false,"description":"Whether to ignore relationships","schema":{"type":"boolean","default":false,"description":"Whether to ignore relationships"}}],"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:confluent-data-catalog-v1/get-tags":{"get":{"operationId":"cloud_confluent_data_catalog_v1_get_tags","summary":"Read Tags for an Entity","description":"GET /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags","tags":["cloud"],"parameters":[{"name":"typeName","in":"query","required":true,"description":"The type of the entity","schema":{"type":"string","description":"The type of the entity"}},{"name":"qualifiedName","in":"query","required":true,"description":"The qualified name of the entity","schema":{"type":"string","description":"The qualified name of the entity"}}],"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:confluent-data-catalog-v1/partial-entity-update":{"post":{"operationId":"cloud_confluent_data_catalog_v1_partial_entity_update","summary":"Update an Entity Attribute","description":"PUT /catalog/v1/entity","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/cloud:confluent-data-catalog-v1/delete-tag":{"post":{"operationId":"cloud_confluent_data_catalog_v1_delete_tag","summary":"Delete a Tag for an Entity","description":"DELETE /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["typeName","qualifiedName","tagName"],"properties":{"typeName":{"type":"string","description":"The type of the entity"},"qualifiedName":{"type":"string","description":"The qualified name of the entity"},"tagName":{"type":"string","description":"The name of the tag"}}}}}},"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:confluent-data-catalog-v1/search-using-attribute":{"get":{"operationId":"cloud_confluent_data_catalog_v1_search_using_attribute","summary":"Search by Attribute","description":"GET /catalog/v1/search/attribute","tags":["cloud"],"parameters":[{"name":"type","in":"query","required":false,"description":"Limit the result to only entities of specified types","schema":{"type":"array","description":"Limit the result to only entities of specified types"}},{"name":"attr","in":"query","required":false,"description":"One of more additional attributes to return in the response","schema":{"type":"array","description":"One of more additional attributes to return in the response"}},{"name":"attrName","in":"query","required":false,"description":"The attribute to search","schema":{"type":"array","description":"The attribute to search"}},{"name":"attrValuePrefix","in":"query","required":false,"description":"The prefix for the attribute value to search","schema":{"type":"array","description":"The prefix for the attribute value to search"}},{"name":"tag","in":"query","required":false,"description":"Limit the result to only entities tagged with the given tag","schema":{"type":"string","description":"Limit the result to only entities tagged with the given tag"}},{"name":"sortBy","in":"query","required":false,"description":"An attribute to sort by","schema":{"type":"string","description":"An attribute to sort by"}},{"name":"sortOrder","in":"query","required":false,"description":"Sort order, either ASCENDING (default) or DESCENDING","schema":{"type":"string","enum":["ASCENDING","DESCENDING"],"description":"Sort order, either ASCENDING (default) or DESCENDING"}},{"name":"deleted","in":"query","required":false,"description":"Whether to include deleted entities","schema":{"type":"boolean","description":"Whether to include deleted entities"}},{"name":"limit","in":"query","required":false,"description":"Limit the result set to only include the specified number of entries (maximum 500)","schema":{"type":"integer","description":"Limit the result set to only include the specified number of entries (maximum 500)"}},{"name":"offset","in":"query","required":false,"description":"Start offset of the result set (useful for pagination)","schema":{"type":"integer","description":"Start offset of the result set (useful for pagination)"}}],"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:confluent-data-catalog-v1/search-using-basic":{"get":{"operationId":"cloud_confluent_data_catalog_v1_search_using_basic","summary":"Search by Fulltext Query","description":"GET /catalog/v1/search/basic","tags":["cloud"],"parameters":[{"name":"query","in":"query","required":false,"description":"The full-text query","schema":{"type":"string","description":"The full-text query"}},{"name":"type","in":"query","required":false,"description":"Limit the result to only entities of specified types","schema":{"type":"array","description":"Limit the result to only entities of specified types"}},{"name":"attr","in":"query","required":false,"description":"One of more additional attributes to return in the response","schema":{"type":"array","description":"One of more additional attributes to return in the response"}},{"name":"tag","in":"query","required":false,"description":"Limit the result to only entities tagged with the given tag","schema":{"type":"string","description":"Limit the result to only entities tagged with the given tag"}},{"name":"sortBy","in":"query","required":false,"description":"An attribute to sort by","schema":{"type":"string","description":"An attribute to sort by"}},{"name":"sortOrder","in":"query","required":false,"description":"Sort order, either ASCENDING (default) or DESCENDING","schema":{"type":"string","enum":["ASCENDING","DESCENDING"],"description":"Sort order, either ASCENDING (default) or DESCENDING"}},{"name":"deleted","in":"query","required":false,"description":"Whether to include deleted entities","schema":{"type":"boolean","description":"Whether to include deleted entities"}},{"name":"limit","in":"query","required":false,"description":"Limit the result set to only include the specified number of entries (maximum 500)","schema":{"type":"integer","description":"Limit the result set to only include the specified number of entries (maximum 500)"}},{"name":"offset","in":"query","required":false,"description":"Start offset of the result set (useful for pagination)","schema":{"type":"integer","description":"Start offset of the result set (useful for pagination)"}}],"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:confluent-data-catalog-v1/get-all-tag-defs":{"get":{"operationId":"cloud_confluent_data_catalog_v1_get_all_tag_defs","summary":"Bulk Read Tag Definitions","description":"GET /catalog/v1/types/tagdefs","tags":["cloud"],"parameters":[{"name":"prefix","in":"query","required":false,"description":"The prefix of a tag definition name","schema":{"type":"string","description":"The prefix of a tag definition 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:confluent-data-catalog-v1/create-tag-defs":{"post":{"operationId":"cloud_confluent_data_catalog_v1_create_tag_defs","summary":"Bulk Create Tag Definitions","description":"POST /catalog/v1/types/tagdefs","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/cloud:confluent-data-catalog-v1/update-tag-defs":{"post":{"operationId":"cloud_confluent_data_catalog_v1_update_tag_defs","summary":"Bulk Update Tag Definitions","description":"PUT /catalog/v1/types/tagdefs","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/cloud:confluent-data-catalog-v1/get-tag-def-by-name":{"get":{"operationId":"cloud_confluent_data_catalog_v1_get_tag_def_by_name","summary":"Read Tag Definition","description":"GET /catalog/v1/types/tagdefs/{tagName}","tags":["cloud"],"parameters":[{"name":"tagName","in":"query","required":true,"description":"The name of the tag definiton","schema":{"type":"string","description":"The name of the tag definiton"}}],"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:confluent-data-catalog-v1/delete-tag-def":{"post":{"operationId":"cloud_confluent_data_catalog_v1_delete_tag_def","summary":"Delete Tag Definition","description":"DELETE /catalog/v1/types/tagdefs/{tagName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tagName"],"properties":{"tagName":{"type":"string","description":"The name of the tag definition"}}}}}},"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"}}}}}}}