{"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-cdx-v1/list-cdx-v1-provider-shared-resources":{"get":{"operationId":"cloud_confluent_cdx_v1_list_cdx_v1_provider_shared_resources","summary":"List of Provider Shared Resources","description":"GET /cdx/v1/provider-shared-resources","tags":["cloud"],"parameters":[{"name":"stream_share","in":"query","required":false,"description":"Filter the results by exact match for stream_share.","schema":{"type":"string","description":"Filter the results by exact match for stream_share."},"example":"ss-1234"},{"name":"crn","in":"query","required":false,"description":"Filter the results by exact match for crn.","schema":{"type":"string","description":"Filter the results by exact match for crn."},"example":"crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic"},{"name":"include_deleted","in":"query","required":false,"description":"Include deactivated shared resources","schema":{"type":"boolean","description":"Include deactivated shared resources"}},{"name":"page_size","in":"query","required":false,"description":"A pagination size for collection requests.","schema":{"type":"integer","default":10,"description":"A pagination size for collection requests."}},{"name":"page_token","in":"query","required":false,"description":"An opaque pagination token for collection requests.","schema":{"type":"string","description":"An opaque pagination token for collection requests."}}],"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-cdx-v1/get-cdx-v1-provider-shared-resource":{"get":{"operationId":"cloud_confluent_cdx_v1_get_cdx_v1_provider_shared_resource","summary":"Read a Provider Shared Resource","description":"GET /cdx/v1/provider-shared-resources/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier for the provider shared resource.","schema":{"type":"string","description":"The unique identifier for the provider shared resource."}}],"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-cdx-v1/update-cdx-v1-provider-shared-resource":{"post":{"operationId":"cloud_confluent_cdx_v1_update_cdx_v1_provider_shared_resource","summary":"Update a Provider Shared Resource","description":"PATCH /cdx/v1/provider-shared-resources/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier for the provider shared resource."},"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-cdx-v1/view-image-cdx-v1-provider-shared-resource":{"get":{"operationId":"cloud_confluent_cdx_v1_view_image_cdx_v1_provider_shared_resource","summary":"View_Image a Provider Shared Resource","description":"GET /cdx/v1/provider-shared-resources/{id}/images/{file_name}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier for the provider shared resource.","schema":{"type":"string","description":"The unique identifier for the provider shared resource."}},{"name":"file_name","in":"query","required":true,"description":"The File Name","schema":{"type":"string","description":"The File 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-cdx-v1/upload-image-cdx-v1-provider-shared-resource":{"post":{"operationId":"cloud_confluent_cdx_v1_upload_image_cdx_v1_provider_shared_resource","summary":"Upload image for shared resource","description":"POST /cdx/v1/provider-shared-resources/{id}/images/{file_name}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","file_name"],"properties":{"id":{"type":"string","description":"The unique identifier for the provider shared resource."},"file_name":{"type":"string","description":"The File 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:confluent-cdx-v1/delete-image-cdx-v1-provider-shared-resource":{"post":{"operationId":"cloud_confluent_cdx_v1_delete_image_cdx_v1_provider_shared_resource","summary":"Delete_Image a Provider Shared Resource","description":"DELETE /cdx/v1/provider-shared-resources/{id}/images/{file_name}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","file_name"],"properties":{"id":{"type":"string","description":"The unique identifier for the provider shared resource."},"file_name":{"type":"string","description":"The File 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:confluent-cdx-v1/list-cdx-v1-provider-shares":{"get":{"operationId":"cloud_confluent_cdx_v1_list_cdx_v1_provider_shares","summary":"List of Provider Shares","description":"GET /cdx/v1/provider-shares","tags":["cloud"],"parameters":[{"name":"shared_resource","in":"query","required":false,"description":"Filter the results by exact match for shared_resource.","schema":{"type":"string","description":"Filter the results by exact match for shared_resource."},"example":"sr-1234"},{"name":"crn","in":"query","required":false,"description":"Filter the results by exact match for crn.","schema":{"type":"string","description":"Filter the results by exact match for crn."},"example":"crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic"},{"name":"include_deleted","in":"query","required":false,"description":"Include deactivated shares","schema":{"type":"boolean","description":"Include deactivated shares"}},{"name":"page_size","in":"query","required":false,"description":"A pagination size for collection requests.","schema":{"type":"integer","default":10,"description":"A pagination size for collection requests."}},{"name":"page_token","in":"query","required":false,"description":"An opaque pagination token for collection requests.","schema":{"type":"string","description":"An opaque pagination token for collection requests."}}],"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-cdx-v1/create-cdx-v1-provider-share":{"post":{"operationId":"cloud_confluent_cdx_v1_create_cdx_v1_provider_share","summary":"Create a provider share","description":"POST /cdx/v1/provider-shares","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-cdx-v1/get-cdx-v1-provider-share":{"get":{"operationId":"cloud_confluent_cdx_v1_get_cdx_v1_provider_share","summary":"Read a Provider Share","description":"GET /cdx/v1/provider-shares/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier for the provider share.","schema":{"type":"string","description":"The unique identifier for the provider share."}}],"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-cdx-v1/delete-cdx-v1-provider-share":{"post":{"operationId":"cloud_confluent_cdx_v1_delete_cdx_v1_provider_share","summary":"Delete a Provider Share","description":"DELETE /cdx/v1/provider-shares/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier for the provider share."}}}}}},"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-cdx-v1/resend-cdx-v1-provider-share":{"post":{"operationId":"cloud_confluent_cdx_v1_resend_cdx_v1_provider_share","summary":"Resend","description":"POST /cdx/v1/provider-shares/{id}:resend","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier for the provider share."}}}}}},"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-cdx-v1/list-cdx-v1-consumer-shared-resources":{"get":{"operationId":"cloud_confluent_cdx_v1_list_cdx_v1_consumer_shared_resources","summary":"List of Consumer Shared Resources","description":"GET /cdx/v1/consumer-shared-resources","tags":["cloud"],"parameters":[{"name":"stream_share","in":"query","required":false,"description":"Filter the results by exact match for stream_share.","schema":{"type":"string","description":"Filter the results by exact match for stream_share."},"example":"ss-1234"},{"name":"include_deleted","in":"query","required":false,"description":"Include deactivated shared resources","schema":{"type":"boolean","description":"Include deactivated shared resources"}},{"name":"page_size","in":"query","required":false,"description":"A pagination size for collection requests.","schema":{"type":"integer","default":10,"description":"A pagination size for collection requests."}},{"name":"page_token","in":"query","required":false,"description":"An opaque pagination token for collection requests.","schema":{"type":"string","description":"An opaque pagination token for collection requests."}}],"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-cdx-v1/get-cdx-v1-consumer-shared-resource":{"get":{"operationId":"cloud_confluent_cdx_v1_get_cdx_v1_consumer_shared_resource","summary":"Read a Consumer Shared Resource","description":"GET /cdx/v1/consumer-shared-resources/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier for the consumer shared resource.","schema":{"type":"string","description":"The unique identifier for the consumer shared resource."}}],"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-cdx-v1/image-cdx-v1-consumer-shared-resource":{"get":{"operationId":"cloud_confluent_cdx_v1_image_cdx_v1_consumer_shared_resource","summary":"Get image for shared resource","description":"GET /cdx/v1/consumer-shared-resources/{id}/images/{file_name}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier for the consumer shared resource.","schema":{"type":"string","description":"The unique identifier for the consumer shared resource."}},{"name":"file_name","in":"query","required":true,"description":"The File Name","schema":{"type":"string","description":"The File 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-cdx-v1/network-cdx-v1-consumer-shared-resource":{"get":{"operationId":"cloud_confluent_cdx_v1_network_cdx_v1_consumer_shared_resource","summary":"Get shared resource's network configuration","description":"GET /cdx/v1/consumer-shared-resources/{id}:network","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier for the consumer shared resource.","schema":{"type":"string","description":"The unique identifier for the consumer shared resource."}}],"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-cdx-v1/list-cdx-v1-consumer-shares":{"get":{"operationId":"cloud_confluent_cdx_v1_list_cdx_v1_consumer_shares","summary":"List of Consumer Shares","description":"GET /cdx/v1/consumer-shares","tags":["cloud"],"parameters":[{"name":"shared_resource","in":"query","required":false,"description":"Filter the results by exact match for shared_resource.","schema":{"type":"string","description":"Filter the results by exact match for shared_resource."},"example":"sr-1234"},{"name":"include_deleted","in":"query","required":false,"description":"Include deactivated shares","schema":{"type":"boolean","description":"Include deactivated shares"}},{"name":"page_size","in":"query","required":false,"description":"A pagination size for collection requests.","schema":{"type":"integer","default":10,"description":"A pagination size for collection requests."}},{"name":"page_token","in":"query","required":false,"description":"An opaque pagination token for collection requests.","schema":{"type":"string","description":"An opaque pagination token for collection requests."}}],"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-cdx-v1/get-cdx-v1-consumer-share":{"get":{"operationId":"cloud_confluent_cdx_v1_get_cdx_v1_consumer_share","summary":"Read a Consumer Share","description":"GET /cdx/v1/consumer-shares/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier for the consumer share.","schema":{"type":"string","description":"The unique identifier for the consumer share."}}],"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-cdx-v1/delete-cdx-v1-consumer-share":{"post":{"operationId":"cloud_confluent_cdx_v1_delete_cdx_v1_consumer_share","summary":"Delete a Consumer Share","description":"DELETE /cdx/v1/consumer-shares/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier for the consumer share."}}}}}},"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-cdx-v1/resources-cdx-v1-shared-token":{"post":{"operationId":"cloud_confluent_cdx_v1_resources_cdx_v1_shared_token","summary":"Validate token to view shared resources","description":"POST /cdx/v1/shared-tokens:resources","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-cdx-v1/redeem-cdx-v1-shared-token":{"post":{"operationId":"cloud_confluent_cdx_v1_redeem_cdx_v1_shared_token","summary":"Redeem token","description":"POST /cdx/v1/shared-tokens:redeem","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-cdx-v1/get-cdx-v1-opt-in":{"get":{"operationId":"cloud_confluent_cdx_v1_get_cdx_v1_opt_in","summary":"Read the organization's stream sharing opt-in settings","description":"GET /cdx/v1/opt-in","tags":["cloud"],"parameters":[],"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-cdx-v1/update-cdx-v1-opt-in":{"post":{"operationId":"cloud_confluent_cdx_v1_update_cdx_v1_opt_in","summary":"Set the organization's stream sharing opt-in settings","description":"PATCH /cdx/v1/opt-in","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"}}},"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"}}}}}}}