{"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-connect-v1/list-connectv1-connectors":{"get":{"operationId":"cloud_confluent_connect_v1_list_connectv1_connectors","summary":"List of Connectors","description":"GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors","tags":["cloud"],"parameters":[{"name":"environment_id","in":"query","required":true,"description":"The unique identifier of the environment this resource belongs to.","schema":{"type":"string","description":"The unique identifier of the environment this resource belongs to."}},{"name":"kafka_cluster_id","in":"query","required":true,"description":"The unique identifier for the Kafka cluster.","schema":{"type":"string","description":"The unique identifier for the Kafka cluster."}}],"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-connect-v1/create-connectv1-connector":{"post":{"operationId":"cloud_confluent_connect_v1_create_connectv1_connector","summary":"Create a Connector","description":"POST /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["environment_id","kafka_cluster_id"],"properties":{"environment_id":{"type":"string","description":"The unique identifier of the environment this resource belongs to."},"kafka_cluster_id":{"type":"string","description":"The unique identifier for the Kafka cluster."},"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-connect-v1/list-connectv1-connectors-with-expansions":{"get":{"operationId":"cloud_confluent_connect_v1_list_connectv1_connectors_with_expansions","summary":"List of Connectors with Expansions","description":"GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id","tags":["cloud"],"parameters":[{"name":"environment_id","in":"query","required":true,"description":"The unique identifier of the environment this resource belongs to.","schema":{"type":"string","description":"The unique identifier of the environment this resource belongs to."}},{"name":"kafka_cluster_id","in":"query","required":true,"description":"The unique identifier for the Kafka cluster.","schema":{"type":"string","description":"The unique identifier for the Kafka cluster."}},{"name":"expand","in":"query","required":false,"description":"- id : Returns metadata of each connector such as id and id type. - info : Returns metadata of each connector such as the configuration,…","schema":{"type":"string","enum":["id","info","status"],"description":"- id : Returns metadata of each connector such as id and id type. - info : Returns metadata of each connector such as the configuration,…"}}],"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-connect-v1/get-connectv1-connector-config":{"get":{"operationId":"cloud_confluent_connect_v1_get_connectv1_connector_config","summary":"Read a Connector Configuration","description":"GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config","tags":["cloud"],"parameters":[{"name":"connector_name","in":"query","required":true,"description":"The unique name of the connector.","schema":{"type":"string","description":"The unique name of the connector."}},{"name":"environment_id","in":"query","required":true,"description":"The unique identifier of the environment this resource belongs to.","schema":{"type":"string","description":"The unique identifier of the environment this resource belongs to."}},{"name":"kafka_cluster_id","in":"query","required":true,"description":"The unique identifier for the Kafka cluster.","schema":{"type":"string","description":"The unique identifier for the Kafka cluster."}}],"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-connect-v1/create-or-update-connectv1-connector-config":{"post":{"operationId":"cloud_confluent_connect_v1_create_or_update_connectv1_connector_config","summary":"Create or Update a Connector Configuration","description":"PUT /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connector_name","environment_id","kafka_cluster_id"],"properties":{"connector_name":{"type":"string","description":"The unique name of the connector."},"environment_id":{"type":"string","description":"The unique identifier of the environment this resource belongs to."},"kafka_cluster_id":{"type":"string","description":"The unique identifier for the Kafka cluster."},"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-connect-v1/read-connectv1-connector":{"get":{"operationId":"cloud_confluent_connect_v1_read_connectv1_connector","summary":"Read a Connector","description":"GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}","tags":["cloud"],"parameters":[{"name":"connector_name","in":"query","required":true,"description":"The unique name of the connector.","schema":{"type":"string","description":"The unique name of the connector."}},{"name":"environment_id","in":"query","required":true,"description":"The unique identifier of the environment this resource belongs to.","schema":{"type":"string","description":"The unique identifier of the environment this resource belongs to."}},{"name":"kafka_cluster_id","in":"query","required":true,"description":"The unique identifier for the Kafka cluster.","schema":{"type":"string","description":"The unique identifier for the Kafka cluster."}}],"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-connect-v1/delete-connectv1-connector":{"post":{"operationId":"cloud_confluent_connect_v1_delete_connectv1_connector","summary":"Delete a Connector","description":"DELETE /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connector_name","environment_id","kafka_cluster_id"],"properties":{"connector_name":{"type":"string","description":"The unique name of the connector."},"environment_id":{"type":"string","description":"The unique identifier of the environment this resource belongs to."},"kafka_cluster_id":{"type":"string","description":"The unique identifier for the Kafka cluster."}}}}}},"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-connect-v1/pause-connectv1-connector":{"post":{"operationId":"cloud_confluent_connect_v1_pause_connectv1_connector","summary":"Pause a Connector","description":"PUT /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connector_name","environment_id","kafka_cluster_id"],"properties":{"connector_name":{"type":"string","description":"The unique name of the connector."},"environment_id":{"type":"string","description":"The unique identifier of the environment this resource belongs to."},"kafka_cluster_id":{"type":"string","description":"The unique identifier for the Kafka cluster."}}}}}},"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-connect-v1/resume-connectv1-connector":{"post":{"operationId":"cloud_confluent_connect_v1_resume_connectv1_connector","summary":"Resume a Connector","description":"PUT /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connector_name","environment_id","kafka_cluster_id"],"properties":{"connector_name":{"type":"string","description":"The unique name of the connector."},"environment_id":{"type":"string","description":"The unique identifier of the environment this resource belongs to."},"kafka_cluster_id":{"type":"string","description":"The unique identifier for the Kafka cluster."}}}}}},"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-connect-v1/read-connectv1-connector-status":{"get":{"operationId":"cloud_confluent_connect_v1_read_connectv1_connector_status","summary":"Read a Connector Status","description":"GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status","tags":["cloud"],"parameters":[{"name":"connector_name","in":"query","required":true,"description":"The unique name of the connector.","schema":{"type":"string","description":"The unique name of the connector."}},{"name":"environment_id","in":"query","required":true,"description":"The unique identifier of the environment this resource belongs to.","schema":{"type":"string","description":"The unique identifier of the environment this resource belongs to."}},{"name":"kafka_cluster_id","in":"query","required":true,"description":"The unique identifier for the Kafka cluster.","schema":{"type":"string","description":"The unique identifier for the Kafka cluster."}}],"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-connect-v1/list-connectv1-connector-tasks":{"get":{"operationId":"cloud_confluent_connect_v1_list_connectv1_connector_tasks","summary":"List of Connector Tasks","description":"GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks","tags":["cloud"],"parameters":[{"name":"connector_name","in":"query","required":true,"description":"The unique name of the connector.","schema":{"type":"string","description":"The unique name of the connector."}},{"name":"environment_id","in":"query","required":true,"description":"The unique identifier of the environment this resource belongs to.","schema":{"type":"string","description":"The unique identifier of the environment this resource belongs to."}},{"name":"kafka_cluster_id","in":"query","required":true,"description":"The unique identifier for the Kafka cluster.","schema":{"type":"string","description":"The unique identifier for the Kafka cluster."}}],"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-connect-v1/list-connectv1-connector-plugins":{"get":{"operationId":"cloud_confluent_connect_v1_list_connectv1_connector_plugins","summary":"List of Managed Connector plugins","description":"GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins","tags":["cloud"],"parameters":[{"name":"environment_id","in":"query","required":true,"description":"The unique identifier of the environment this resource belongs to.","schema":{"type":"string","description":"The unique identifier of the environment this resource belongs to."}},{"name":"kafka_cluster_id","in":"query","required":true,"description":"The unique identifier for the Kafka cluster.","schema":{"type":"string","description":"The unique identifier for the Kafka cluster."}}],"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-connect-v1/validate-connectv1-connector-plugin":{"post":{"operationId":"cloud_confluent_connect_v1_validate_connectv1_connector_plugin","summary":"Validate a Managed Connector Plugin","description":"PUT /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["plugin_name","environment_id","kafka_cluster_id"],"properties":{"plugin_name":{"type":"string","description":"The unique name of the connector plugin."},"environment_id":{"type":"string","description":"The unique identifier of the environment this resource belongs to."},"kafka_cluster_id":{"type":"string","description":"The unique identifier for the Kafka cluster."},"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-connect-v1/get-connectv1-connector-offsets":{"get":{"operationId":"cloud_confluent_connect_v1_get_connectv1_connector_offsets","summary":"Get a Connector Offsets","description":"GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets","tags":["cloud"],"parameters":[{"name":"connector_name","in":"query","required":true,"description":"The unique name of the connector.","schema":{"type":"string","description":"The unique name of the connector."}},{"name":"environment_id","in":"query","required":true,"description":"The unique identifier of the environment this resource belongs to.","schema":{"type":"string","description":"The unique identifier of the environment this resource belongs to."}},{"name":"kafka_cluster_id","in":"query","required":true,"description":"The unique identifier for the Kafka cluster.","schema":{"type":"string","description":"The unique identifier for the Kafka cluster."}}],"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-connect-v1/alter-connectv1-connector-offsets-request":{"post":{"operationId":"cloud_confluent_connect_v1_alter_connectv1_connector_offsets_request","summary":"Request to Alter the Connector Offsets","description":"POST /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connector_name","environment_id","kafka_cluster_id"],"properties":{"connector_name":{"type":"string","description":"The unique name of the connector."},"environment_id":{"type":"string","description":"The unique identifier of the environment this resource belongs to."},"kafka_cluster_id":{"type":"string","description":"The unique identifier for the Kafka cluster."},"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-connect-v1/get-connectv1-connector-offsets-request-status":{"get":{"operationId":"cloud_confluent_connect_v1_get_connectv1_connector_offsets_request_status","summary":"Get the Status of Altered Offset Request","description":"GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status","tags":["cloud"],"parameters":[{"name":"connector_name","in":"query","required":true,"description":"The unique name of the connector.","schema":{"type":"string","description":"The unique name of the connector."}},{"name":"environment_id","in":"query","required":true,"description":"The unique identifier of the environment this resource belongs to.","schema":{"type":"string","description":"The unique identifier of the environment this resource belongs to."}},{"name":"kafka_cluster_id","in":"query","required":true,"description":"The unique identifier for the Kafka cluster.","schema":{"type":"string","description":"The unique identifier for the Kafka cluster."}}],"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":"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"}}}}}}}