{"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-byok-v1/list-byok-v1-keys":{"get":{"operationId":"cloud_confluent_byok_v1_list_byok_v1_keys","summary":"List of Keys","description":"GET /byok/v1/keys","tags":["cloud"],"parameters":[{"name":"display_name","in":"query","required":false,"description":"Filter the results by a partial search of display_name.","schema":{"type":"string","description":"Filter the results by a partial search of display_name."},"example":"Key for billing cluster"},{"name":"provider","in":"query","required":false,"description":"Filter the results by exact match for provider.","schema":{"type":"string","description":"Filter the results by exact match for provider."},"example":"AWS"},{"name":"state","in":"query","required":false,"description":"Filter the results by exact match for state.","schema":{"type":"string","description":"Filter the results by exact match for state."},"example":"IN_USE"},{"name":"validation_phase","in":"query","required":false,"description":"Filter the results by exact match for validation_phase.","schema":{"type":"string","description":"Filter the results by exact match for validation_phase."}},{"name":"validation_region","in":"query","required":false,"description":"Filter keys by the cloud region where they are deployed.","schema":{"type":"string","description":"Filter keys by the cloud region where they are deployed."},"example":"us-west-2"},{"name":"key","in":"query","required":false,"description":"Filters results by a partial match on the key identifier: key_arn for AWS, key_id for Azure and GCP.","schema":{"type":"string","description":"Filters results by a partial match on the key identifier: key_arn for AWS, key_id for Azure and GCP."},"example":"vault-name"},{"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-byok-v1/create-byok-v1-key":{"post":{"operationId":"cloud_confluent_byok_v1_create_byok_v1_key","summary":"Create a Key","description":"POST /byok/v1/keys","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-byok-v1/get-byok-v1-key":{"get":{"operationId":"cloud_confluent_byok_v1_get_byok_v1_key","summary":"Read a Key","description":"GET /byok/v1/keys/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier for the key.","schema":{"type":"string","description":"The unique identifier for the key."}}],"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-byok-v1/update-byok-v1-key":{"post":{"operationId":"cloud_confluent_byok_v1_update_byok_v1_key","summary":"Update a Key","description":"PATCH /byok/v1/keys/{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 key."},"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-byok-v1/delete-byok-v1-key":{"post":{"operationId":"cloud_confluent_byok_v1_delete_byok_v1_key","summary":"Delete a Key","description":"DELETE /byok/v1/keys/{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 key."}}}}}},"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"}}}}}}}