{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:coalesce/environments-list-information":{"get":{"operationId":"open_data_coalesce_environments_list_information","summary":"List Environments","description":"GET /api/v1/environments","tags":["open-data"],"parameters":[{"name":"detail","in":"query","required":false,"description":"Include the full detail of the environments.","schema":{"type":"boolean","default":false,"description":"Include the full detail of the environments."}}],"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/open-data:coalesce/environments-get-information":{"get":{"operationId":"open_data_coalesce_environments_get_information","summary":"Get Environment","description":"GET /api/v1/environments/{environmentID}","tags":["open-data"],"parameters":[{"name":"environmentID","in":"query","required":true,"description":"The environment ID.","schema":{"type":"string","description":"The environment ID."}}],"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/open-data:coalesce/nodes-list":{"get":{"operationId":"open_data_coalesce_nodes_list","summary":"List Nodes","description":"GET /api/v1/environments/{environmentID}/nodes","tags":["open-data"],"parameters":[{"name":"environmentID","in":"query","required":true,"description":"The environment ID.","schema":{"type":"string","description":"The environment ID."}},{"name":"detail","in":"query","required":false,"description":"Include the full detail of the nodes.","schema":{"type":"boolean","default":false,"description":"Include the full detail of the nodes."}}],"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/open-data:coalesce/nodes-get-information":{"get":{"operationId":"open_data_coalesce_nodes_get_information","summary":"Get Node","description":"GET /api/v1/environments/{environmentID}/nodes/{nodeID}","tags":["open-data"],"parameters":[{"name":"environmentID","in":"query","required":true,"description":"The environment ID.","schema":{"type":"string","description":"The environment ID."}},{"name":"nodeID","in":"query","required":true,"description":"The node ID.","schema":{"type":"string","description":"The node ID."}}],"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/open-data:coalesce/runs-list-information":{"get":{"operationId":"open_data_coalesce_runs_list_information","summary":"List Runs","description":"GET /api/v1/runs","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The maximum number of runs to return.","schema":{"type":"integer","default":25,"description":"The maximum number of runs to return."}},{"name":"startingFrom","in":"query","required":false,"description":"The starting run ID, runStartTime, or runEndTime (exclusive) for paging the query results.","schema":{"type":"string","description":"The starting run ID, runStartTime, or runEndTime (exclusive) for paging the query results."}},{"name":"orderBy","in":"query","required":false,"description":"The field used to order results.","schema":{"type":"string","enum":["id","runStartTime","runEndTime"],"default":"id","description":"The field used to order results."}},{"name":"orderByDirection","in":"query","required":false,"description":"The sort order for query results.","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"The sort order for query results."}},{"name":"runType","in":"query","required":false,"description":"A run type to filter the query results.","schema":{"type":"string","enum":["deploy","refresh"],"description":"A run type to filter the query results."}},{"name":"runStatus","in":"query","required":false,"description":"A status value to filter the query results.","schema":{"type":"string","enum":["canceled","completed","failed","running","waitingToRun"],"description":"A status value to filter the query results."}},{"name":"environmentID","in":"query","required":false,"description":"An environment ID to filter the query results.","schema":{"type":"string","description":"An environment ID to filter the query results."}},{"name":"detail","in":"query","required":false,"description":"Include the full detail of the run.","schema":{"type":"boolean","default":false,"description":"Include the full detail of the run."}}],"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/open-data:coalesce/runs-get-run-details":{"get":{"operationId":"open_data_coalesce_runs_get_run_details","summary":"Get Run","description":"GET /api/v1/runs/{runID}","tags":["open-data"],"parameters":[{"name":"runID","in":"query","required":true,"description":"The run ID.","schema":{"type":"integer","description":"The run ID."}}],"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/open-data:coalesce/runs-list-results":{"get":{"operationId":"open_data_coalesce_runs_list_results","summary":"List Run Results","description":"GET /api/v1/runs/{runID}/results","tags":["open-data"],"parameters":[{"name":"runID","in":"query","required":true,"description":"The run ID.","schema":{"type":"integer","description":"The run ID."}}],"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/open-data:coalesce/jobs-initiate-run":{"post":{"operationId":"open_data_coalesce_jobs_initiate_run","summary":"Trigger Job to Run","description":"POST /scheduler/startRun","tags":["open-data"],"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/open-data:coalesce/jobs-get-status-updates":{"get":{"operationId":"open_data_coalesce_jobs_get_status_updates","summary":"Get Job Status","description":"GET /scheduler/runStatus","tags":["open-data"],"parameters":[{"name":"runCounter","in":"query","required":true,"description":"ID of the run to query","schema":{"type":"integer","description":"ID of the run to query"}}],"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/open-data:coalesce/jobs-trigger-rerun":{"post":{"operationId":"open_data_coalesce_jobs_trigger_rerun","summary":"Trigger Job to Re-Run","description":"POST /scheduler/rerun","tags":["open-data"],"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/open-data:coalesce/jobs-cancel-job-run":{"post":{"operationId":"open_data_coalesce_jobs_cancel_job_run","summary":"Cancel Running Job","description":"POST /scheduler/cancelRun","tags":["open-data"],"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"}}}}}}}