{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/dev-tools:circleci/get-me":{"get":{"operationId":"dev_tools_circleci_get_me","summary":"Provides information about the signed in user.","description":"GET /me","tags":["dev-tools"],"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/dev-tools:circleci/get-project-username-project":{"get":{"operationId":"dev_tools_circleci_get_project_username_project","summary":"Build summary for each of the last 30 builds for a single git repo.","description":"GET /project/{username}/{project}","tags":["dev-tools"],"parameters":[{"name":"username","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"project","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"limit","in":"query","required":false,"description":"The number of builds to return. Maximum 100, defaults to 30.","schema":{"type":"integer","default":30,"description":"The number of builds to return. Maximum 100, defaults to 30."}},{"name":"offset","in":"query","required":false,"description":"The API returns builds starting from this offset, defaults to 0.","schema":{"type":"integer","default":0,"description":"The API returns builds starting from this offset, defaults to 0."}},{"name":"filter","in":"query","required":false,"description":"Restricts which builds are returned. Set to \"completed\", \"successful\", \"failed\", \"running\", or defaults to no filter.","schema":{"type":"string","enum":["completed","successful","failed","running"],"description":"Restricts which builds are returned. Set to \"completed\", \"successful\", \"failed\", \"running\", or defaults to no filter."}}],"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/dev-tools:circleci/post-project-username-project":{"post":{"operationId":"dev_tools_circleci_post_project_username_project","summary":"Triggers a new build, returns a summary of the build.","description":"POST /project/{username}/{project}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"},"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/dev-tools:circleci/delete-project-username-project-build-cache":{"post":{"operationId":"dev_tools_circleci_delete_project_username_project_build_cache","summary":"Clears the cache for a project.","description":"DELETE /project/{username}/{project}/build-cache","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"}}}}}},"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/dev-tools:circleci/get-project-username-project-checkout-key":{"get":{"operationId":"dev_tools_circleci_get_project_username_project_checkout_key","summary":"Lists checkout keys.","description":"GET /project/{username}/{project}/checkout-key","tags":["dev-tools"],"parameters":[{"name":"username","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"project","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}}],"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/dev-tools:circleci/post-project-username-project-checkout-key":{"post":{"operationId":"dev_tools_circleci_post_project_username_project_checkout_key","summary":"Creates a new checkout key. Only usable with a user API token.","description":"POST /project/{username}/{project}/checkout-key","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"},"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/dev-tools:circleci/get-project-username-project-checkout-key-fingerprint":{"get":{"operationId":"dev_tools_circleci_get_project_username_project_checkout_key_fingerprint","summary":"Get a checkout key.","description":"GET /project/{username}/{project}/checkout-key/{fingerprint}","tags":["dev-tools"],"parameters":[{"name":"username","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"project","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"fingerprint","in":"query","required":true,"description":"XXXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXXX"}}],"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/dev-tools:circleci/delete-project-username-project-checkout-key-fingerprint":{"post":{"operationId":"dev_tools_circleci_delete_project_username_project_checkout_key_fingerprint","summary":"Delete a checkout key.","description":"DELETE /project/{username}/{project}/checkout-key/{fingerprint}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project","fingerprint"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"},"fingerprint":{"type":"string","description":"XXXXXXXXXX"}}}}}},"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/dev-tools:circleci/get-project-username-project-envvar":{"get":{"operationId":"dev_tools_circleci_get_project_username_project_envvar","summary":"Lists the environment variables for :project","description":"GET /project/{username}/{project}/envvar","tags":["dev-tools"],"parameters":[{"name":"username","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"project","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}}],"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/dev-tools:circleci/post-project-username-project-envvar":{"post":{"operationId":"dev_tools_circleci_post_project_username_project_envvar","summary":"Creates a new environment variable","description":"POST /project/{username}/{project}/envvar","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"}}}}}},"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/dev-tools:circleci/get-project-username-project-envvar-name":{"get":{"operationId":"dev_tools_circleci_get_project_username_project_envvar_name","summary":"Gets the hidden value of environment variable :name","description":"GET /project/{username}/{project}/envvar/{name}","tags":["dev-tools"],"parameters":[{"name":"username","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"project","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"name","in":"query","required":true,"description":"XXXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXXX"}}],"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/dev-tools:circleci/delete-project-username-project-envvar-name":{"post":{"operationId":"dev_tools_circleci_delete_project_username_project_envvar_name","summary":"Deletes the environment variable named ':name'","description":"DELETE /project/{username}/{project}/envvar/{name}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project","name"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"},"name":{"type":"string","description":"XXXXXXXXXX"}}}}}},"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/dev-tools:circleci/post-project-username-project-ssh-key":{"post":{"operationId":"dev_tools_circleci_post_project_username_project_ssh_key","summary":"Create an ssh key used to access external systems that require SSH key-based authentication","description":"POST /project/{username}/{project}/ssh-key","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project","body"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"},"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/dev-tools:circleci/post-project-username-project-tree-branch":{"post":{"operationId":"dev_tools_circleci_post_project_username_project_tree_branch","summary":"Triggers a new build, returns a summary of the build. Optional build parameters can be set using an…","description":"POST /project/{username}/{project}/tree/{branch}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project","branch"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"},"branch":{"type":"string","description":"The branch name should be url-encoded."},"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/dev-tools:circleci/get-project-username-project-build-num":{"get":{"operationId":"dev_tools_circleci_get_project_username_project_build_num","summary":"Full details for a single build. The response includes all of the fields from the build summary. This is…","description":"GET /project/{username}/{project}/{build_num}","tags":["dev-tools"],"parameters":[{"name":"username","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"project","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"build_num","in":"query","required":true,"description":"XXXXXXXXXX","schema":{"type":"integer","description":"XXXXXXXXXX"}}],"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/dev-tools:circleci/get-project-username-project-build-num-artifacts":{"get":{"operationId":"dev_tools_circleci_get_project_username_project_build_num_artifacts","summary":"List the artifacts produced by a given build.","description":"GET /project/{username}/{project}/{build_num}/artifacts","tags":["dev-tools"],"parameters":[{"name":"username","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"project","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"build_num","in":"query","required":true,"description":"XXXXXXXXXX","schema":{"type":"integer","description":"XXXXXXXXXX"}}],"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/dev-tools:circleci/post-project-username-project-build-num-cancel":{"post":{"operationId":"dev_tools_circleci_post_project_username_project_build_num_cancel","summary":"Cancels the build, returns a summary of the build.","description":"POST /project/{username}/{project}/{build_num}/cancel","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project","build_num"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"},"build_num":{"type":"integer","description":"XXXXXXXXXX"}}}}}},"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/dev-tools:circleci/post-project-username-project-build-num-retry":{"post":{"operationId":"dev_tools_circleci_post_project_username_project_build_num_retry","summary":"Retries the build, returns a summary of the new build.","description":"POST /project/{username}/{project}/{build_num}/retry","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project","build_num"],"properties":{"username":{"type":"string","description":"XXXXXXXXX"},"project":{"type":"string","description":"XXXXXXXXX"},"build_num":{"type":"integer","description":"XXXXXXXXXX"}}}}}},"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/dev-tools:circleci/get-project-username-project-build-num-tests":{"get":{"operationId":"dev_tools_circleci_get_project_username_project_build_num_tests","summary":"Provides test metadata for a build Note: [Learn how to set up your builds to collect test…","description":"GET /project/{username}/{project}/{build_num}/tests","tags":["dev-tools"],"parameters":[{"name":"username","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"project","in":"query","required":true,"description":"XXXXXXXXX","schema":{"type":"string","description":"XXXXXXXXX"}},{"name":"build_num","in":"query","required":true,"description":"XXXXXXXXXX","schema":{"type":"integer","description":"XXXXXXXXXX"}}],"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/dev-tools:circleci/get-projects":{"get":{"operationId":"dev_tools_circleci_get_projects","summary":"List of all the projects you're following on CircleCI, with build information organized by branch.","description":"GET /projects","tags":["dev-tools"],"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/dev-tools:circleci/get-recent-builds":{"get":{"operationId":"dev_tools_circleci_get_recent_builds","summary":"Build summary for each of the last 30 recent builds, ordered by build_num.","description":"GET /recent-builds","tags":["dev-tools"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The number of builds to return. Maximum 100, defaults to 30.","schema":{"type":"integer","default":30,"description":"The number of builds to return. Maximum 100, defaults to 30."}},{"name":"offset","in":"query","required":false,"description":"The API returns builds starting from this offset, defaults to 0.","schema":{"type":"integer","default":0,"description":"The API returns builds starting from this offset, defaults to 0."}}],"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/dev-tools:circleci/post-user-heroku-key":{"post":{"operationId":"dev_tools_circleci_post_user_heroku_key","summary":"Adds your Heroku API key to CircleCI, takes apikey as form param name.","description":"POST /user/heroku-key","tags":["dev-tools"],"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":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"}}}}}}}