{"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/open-data:circleci/context-list-owner-contexts":{"get":{"operationId":"open_data_circleci_context_list_owner_contexts","summary":"List contexts","description":"GET /context","tags":["open-data"],"parameters":[{"name":"owner-id","in":"query","required":false,"description":"The unique ID of the owner of the context. Specify either this or owner-slug.","schema":{"type":"string","description":"The unique ID of the owner of the context. Specify either this or owner-slug."}},{"name":"owner-slug","in":"query","required":false,"description":"A string that represents an organization. Specify either this or owner-id. Cannot be used for accounts.","schema":{"type":"string","description":"A string that represents an organization. Specify either this or owner-id. Cannot be used for accounts."}},{"name":"owner-type","in":"query","required":false,"description":"The type of the owner. Defaults to \"organization\". Accounts are only used as context owners in server.","schema":{"type":"string","enum":["account","organization"],"description":"The type of the owner. Defaults to \"organization\". Accounts are only used as context owners in server."}},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}}],"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:circleci/context-create-new-context":{"post":{"operationId":"open_data_circleci_context_create_new_context","summary":"Create a new context","description":"POST /context","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:circleci/context-get-information":{"get":{"operationId":"open_data_circleci_context_get_information","summary":"Get a context","description":"GET /context/{context-id}","tags":["open-data"],"parameters":[{"name":"context-id","in":"query","required":true,"description":"ID of the context (UUID)","schema":{"type":"string","description":"ID of the context (UUID)"}}],"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:circleci/context-remove-context":{"post":{"operationId":"open_data_circleci_context_remove_context","summary":"Delete a context","description":"DELETE /context/{context-id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["context-id"],"properties":{"context-id":{"type":"string","description":"ID of the context (UUID)"}}}}}},"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:circleci/context-list-environment-variables":{"get":{"operationId":"open_data_circleci_context_list_environment_variables","summary":"List environment variables","description":"GET /context/{context-id}/environment-variable","tags":["open-data"],"parameters":[{"name":"context-id","in":"query","required":true,"description":"ID of the context (UUID)","schema":{"type":"string","description":"ID of the context (UUID)"}},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}}],"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:circleci/context-update-environment-variable":{"post":{"operationId":"open_data_circleci_context_update_environment_variable","summary":"Add or update an environment variable","description":"PUT /context/{context-id}/environment-variable/{env-var-name}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["context-id","env-var-name"],"properties":{"context-id":{"type":"string","description":"ID of the context (UUID)"},"env-var-name":{"type":"string","description":"The name of the environment variable"},"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:circleci/context-remove-environment-variable":{"post":{"operationId":"open_data_circleci_context_remove_environment_variable","summary":"Remove an environment variable","description":"DELETE /context/{context-id}/environment-variable/{env-var-name}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["env-var-name","context-id"],"properties":{"env-var-name":{"type":"string","description":"The name of the environment variable"},"context-id":{"type":"string","description":"ID of the context (UUID)"}}}}}},"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:circleci/insights-get-project-summary-metrics":{"get":{"operationId":"open_data_circleci_insights_get_project_summary_metrics","summary":"Get summary metrics and trends for a project across it's workflows and branches","description":"GET /insights/pages/{project-slug}/summary","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"reporting-window","in":"query","required":false,"description":"The time window used to calculate summary metrics. If not provided, defaults to last-90-days","schema":{"type":"string","enum":["last-7-days","last-90-days","last-24-hours","last-30-days","last-60-days"],"description":"The time window used to calculate summary metrics. If not provided, defaults to last-90-days"},"example":"last-90-days"},{"name":"branches","in":"query","required":false,"description":"The names of VCS branches to include in branch-level workflow metrics.","schema":{"type":"object","description":"The names of VCS branches to include in branch-level workflow metrics."},"example":"A single branch: ?branches=main or for multiple branches: ?branches=main&branches=feature&branches=dev"},{"name":"workflow-names","in":"query","required":false,"description":"The names of workflows to include in workflow-level metrics.","schema":{"type":"object","description":"The names of workflows to include in workflow-level metrics."},"example":"A single workflow name: ?workflow-names=build-test-deploy or\n    for multiple workflow names: ?workflow-names=build&workflow-names=test-and-deploy."}],"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:circleci/insights-get-job-timeseries-data":{"get":{"operationId":"open_data_circleci_insights_get_job_timeseries_data","summary":"Job timeseries data","description":"GET /insights/time-series/{project-slug}/workflows/{workflow-name}/jobs","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"workflow-name","in":"query","required":true,"description":"The name of the workflow.","schema":{"type":"string","description":"The name of the workflow."},"example":"build-and-test"},{"name":"branch","in":"query","required":false,"description":"The name of a vcs branch. If not passed we will scope the API call to the default branch.","schema":{"type":"string","description":"The name of a vcs branch. If not passed we will scope the API call to the default branch."}},{"name":"granularity","in":"query","required":false,"description":"The granularity for which to query timeseries data.","schema":{"type":"string","enum":["daily","hourly"],"description":"The granularity for which to query timeseries data."},"example":"hourly"},{"name":"start-date","in":"query","required":false,"description":"Include only executions that started at or after this date. This must be specified if an end-date is provided.","schema":{"type":"string","description":"Include only executions that started at or after this date. This must be specified if an end-date is provided."},"example":"2020-08-21T13:26:29Z"},{"name":"end-date","in":"query","required":false,"description":"Include only executions that started before this date. This date can be at most 90 days after the start-date.","schema":{"type":"string","description":"Include only executions that started before this date. This date can be at most 90 days after the start-date."},"example":"2020-09-04T13:26:29Z"}],"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:circleci/insights-get-summary-metrics-with-trends":{"get":{"operationId":"open_data_circleci_insights_get_summary_metrics_with_trends","summary":"Get summary metrics with trends for the entire org, and for each project.","description":"GET /insights/{org-slug}/summary","tags":["open-data"],"parameters":[{"name":"org-slug","in":"query","required":true,"description":"Org slug in the form `vcs-slug/org-name`. The `/` characters may be URL-escaped.","schema":{"type":"string","description":"Org slug in the form `vcs-slug/org-name`. The `/` characters may be URL-escaped."},"example":"gh/CircleCI-Public"},{"name":"reporting-window","in":"query","required":false,"description":"The time window used to calculate summary metrics. If not provided, defaults to last-90-days","schema":{"type":"string","enum":["last-7-days","last-90-days","last-24-hours","last-30-days","last-60-days"],"description":"The time window used to calculate summary metrics. If not provided, defaults to last-90-days"},"example":"last-90-days"},{"name":"project-names","in":"query","required":false,"description":"List of project names.","schema":{"type":"object","description":"List of project names."},"example":"For a single project: ?project-names=some-project or for multiple projects: ?project-names=some-project1&project-names=some-project2"}],"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:circleci/insights-list-project-branches":{"get":{"operationId":"open_data_circleci_insights_list_project_branches","summary":"Get all branches for a project","description":"GET /insights/{project-slug}/branches","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"workflow-name","in":"query","required":false,"description":"The name of a workflow. If not passed we will scope the API call to the project.","schema":{"type":"string","description":"The name of a workflow. If not passed we will scope the API call to the project."},"example":"build-and-test"}],"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:circleci/insights-get-flaky-tests":{"get":{"operationId":"open_data_circleci_insights_get_flaky_tests","summary":"Get flaky tests for a project","description":"GET /insights/{project-slug}/flaky-tests","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"}],"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:circleci/insights-get-project-workflow-metrics":{"get":{"operationId":"open_data_circleci_insights_get_project_workflow_metrics","summary":"Get summary metrics for a project's workflows","description":"GET /insights/{project-slug}/workflows","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}},{"name":"all-branches","in":"query","required":false,"description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.","schema":{"type":"boolean","description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."}},{"name":"branch","in":"query","required":false,"description":"The name of a vcs branch. If not passed we will scope the API call to the default branch.","schema":{"type":"string","description":"The name of a vcs branch. If not passed we will scope the API call to the default branch."}},{"name":"reporting-window","in":"query","required":false,"description":"The time window used to calculate summary metrics. If not provided, defaults to last-90-days","schema":{"type":"string","enum":["last-7-days","last-90-days","last-24-hours","last-30-days","last-60-days"],"description":"The time window used to calculate summary metrics. If not provided, defaults to last-90-days"},"example":"last-90-days"}],"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:circleci/insights-get-recent-workflow-runs":{"get":{"operationId":"open_data_circleci_insights_get_recent_workflow_runs","summary":"Get recent runs of a workflow","description":"GET /insights/{project-slug}/workflows/{workflow-name}","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"workflow-name","in":"query","required":true,"description":"The name of the workflow.","schema":{"type":"string","description":"The name of the workflow."},"example":"build-and-test"},{"name":"all-branches","in":"query","required":false,"description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.","schema":{"type":"boolean","description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."}},{"name":"branch","in":"query","required":false,"description":"The name of a vcs branch. If not passed we will scope the API call to the default branch.","schema":{"type":"string","description":"The name of a vcs branch. If not passed we will scope the API call to the default branch."}},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}},{"name":"start-date","in":"query","required":false,"description":"Include only executions that started at or after this date. This must be specified if an end-date is provided.","schema":{"type":"string","description":"Include only executions that started at or after this date. This must be specified if an end-date is provided."},"example":"2020-08-21T13:26:29Z"},{"name":"end-date","in":"query","required":false,"description":"Include only executions that started before this date. This date can be at most 90 days after the start-date.","schema":{"type":"string","description":"Include only executions that started before this date. This date can be at most 90 days after the start-date."},"example":"2020-09-04T13:26:29Z"}],"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:circleci/insights-get-project-workflow-job-metrics":{"get":{"operationId":"open_data_circleci_insights_get_project_workflow_job_metrics","summary":"Get summary metrics for a project workflow's jobs.","description":"GET /insights/{project-slug}/workflows/{workflow-name}/jobs","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"workflow-name","in":"query","required":true,"description":"The name of the workflow.","schema":{"type":"string","description":"The name of the workflow."},"example":"build-and-test"},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}},{"name":"all-branches","in":"query","required":false,"description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.","schema":{"type":"boolean","description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."}},{"name":"branch","in":"query","required":false,"description":"The name of a vcs branch. If not passed we will scope the API call to the default branch.","schema":{"type":"string","description":"The name of a vcs branch. If not passed we will scope the API call to the default branch."}},{"name":"reporting-window","in":"query","required":false,"description":"The time window used to calculate summary metrics. If not provided, defaults to last-90-days","schema":{"type":"string","enum":["last-7-days","last-90-days","last-24-hours","last-30-days","last-60-days"],"description":"The time window used to calculate summary metrics. If not provided, defaults to last-90-days"},"example":"last-90-days"}],"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:circleci/insights-get-workflow-summary-metrics":{"get":{"operationId":"open_data_circleci_insights_get_workflow_summary_metrics","summary":"Get metrics and trends for workflows","description":"GET /insights/{project-slug}/workflows/{workflow-name}/summary","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"workflow-name","in":"query","required":true,"description":"The name of the workflow.","schema":{"type":"string","description":"The name of the workflow."},"example":"build-and-test"},{"name":"all-branches","in":"query","required":false,"description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.","schema":{"type":"boolean","description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."}},{"name":"branch","in":"query","required":false,"description":"The name of a vcs branch. If not passed we will scope the API call to the default branch.","schema":{"type":"string","description":"The name of a vcs branch. If not passed we will scope the API call to the default branch."}}],"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:circleci/insights-get-project-workflow-test-metrics":{"get":{"operationId":"open_data_circleci_insights_get_project_workflow_test_metrics","summary":"Get test metrics for a project's workflows","description":"GET /insights/{project-slug}/workflows/{workflow-name}/test-metrics","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"workflow-name","in":"query","required":true,"description":"The name of the workflow.","schema":{"type":"string","description":"The name of the workflow."},"example":"build-and-test"},{"name":"branch","in":"query","required":false,"description":"The name of a vcs branch. If not passed we will scope the API call to the default branch.","schema":{"type":"string","description":"The name of a vcs branch. If not passed we will scope the API call to the default branch."}},{"name":"all-branches","in":"query","required":false,"description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.","schema":{"type":"boolean","description":"Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."}}],"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:circleci/user-get-information":{"get":{"operationId":"open_data_circleci_user_get_information","summary":"User Information","description":"GET /me","tags":["open-data"],"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/open-data:circleci/user-list-collaborations":{"get":{"operationId":"open_data_circleci_user_list_collaborations","summary":"Collaborations","description":"GET /me/collaborations","tags":["open-data"],"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/open-data:circleci/pipeline-list-recent-pipelines":{"get":{"operationId":"open_data_circleci_pipeline_list_recent_pipelines","summary":"Get a list of pipelines","description":"GET /pipeline","tags":["open-data"],"parameters":[{"name":"org-slug","in":"query","required":false,"description":"Org slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the…","schema":{"type":"string","description":"Org slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the…"},"example":"gh/CircleCI-Public"},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}},{"name":"mine","in":"query","required":false,"description":"Only include entries created by your user.","schema":{"type":"boolean","description":"Only include entries created by your user."}}],"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:circleci/pipeline-continue-execution":{"post":{"operationId":"open_data_circleci_pipeline_continue_execution","summary":"Continue a pipeline","description":"POST /pipeline/continue","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:circleci/pipeline-get-by-id":{"get":{"operationId":"open_data_circleci_pipeline_get_by_id","summary":"Get a pipeline by ID","description":"GET /pipeline/{pipeline-id}","tags":["open-data"],"parameters":[{"name":"pipeline-id","in":"query","required":true,"description":"The unique ID of the pipeline.","schema":{"type":"string","description":"The unique ID of the pipeline."},"example":"5034460f-c7c4-4c43-9457-de07e2029e7b"}],"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:circleci/pipeline-get-configuration-by-id":{"get":{"operationId":"open_data_circleci_pipeline_get_configuration_by_id","summary":"Get a pipeline's configuration","description":"GET /pipeline/{pipeline-id}/config","tags":["open-data"],"parameters":[{"name":"pipeline-id","in":"query","required":true,"description":"The unique ID of the pipeline.","schema":{"type":"string","description":"The unique ID of the pipeline."},"example":"5034460f-c7c4-4c43-9457-de07e2029e7b"}],"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:circleci/pipeline-list-workflows":{"get":{"operationId":"open_data_circleci_pipeline_list_workflows","summary":"Get a pipeline's workflows","description":"GET /pipeline/{pipeline-id}/workflow","tags":["open-data"],"parameters":[{"name":"pipeline-id","in":"query","required":true,"description":"The unique ID of the pipeline.","schema":{"type":"string","description":"The unique ID of the pipeline."},"example":"5034460f-c7c4-4c43-9457-de07e2029e7b"},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}}],"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:circleci/project-get-by-slug":{"get":{"operationId":"open_data_circleci_project_get_by_slug","summary":"Get a project","description":"GET /project/{project-slug}","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"}],"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:circleci/project-list-checkout-keys":{"get":{"operationId":"open_data_circleci_project_list_checkout_keys","summary":"Get all checkout keys","description":"GET /project/{project-slug}/checkout-key","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"digest","in":"query","required":false,"description":"The fingerprint digest type to return. This may be either `md5` or `sha256`. If not passed, defaults to `md5`.","schema":{"type":"string","enum":["sha256","md5"],"description":"The fingerprint digest type to return. This may be either `md5` or `sha256`. If not passed, defaults to `md5`."}}],"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:circleci/project-create-checkout-key":{"post":{"operationId":"open_data_circleci_project_create_checkout_key","summary":"Create a new checkout key","description":"POST /project/{project-slug}/checkout-key","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-slug"],"properties":{"project-slug":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"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:circleci/project-get-checkout-key-by-fingerprint":{"get":{"operationId":"open_data_circleci_project_get_checkout_key_by_fingerprint","summary":"Get a checkout key","description":"GET /project/{project-slug}/checkout-key/{fingerprint}","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"fingerprint","in":"query","required":true,"description":"An SSH key fingerprint.","schema":{"type":"string","description":"An SSH key fingerprint."},"example":"c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f"}],"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:circleci/project-delete-checkout-key-by-fingerprint":{"post":{"operationId":"open_data_circleci_project_delete_checkout_key_by_fingerprint","summary":"Delete a checkout key","description":"DELETE /project/{project-slug}/checkout-key/{fingerprint}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-slug","fingerprint"],"properties":{"project-slug":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"fingerprint":{"type":"string","description":"An SSH key fingerprint."}}}}}},"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:circleci/project-list-env-var-values":{"get":{"operationId":"open_data_circleci_project_list_env_var_values","summary":"List all environment variables","description":"GET /project/{project-slug}/envvar","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"}],"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:circleci/project-create-env-var":{"post":{"operationId":"open_data_circleci_project_create_env_var","summary":"Create an environment variable","description":"POST /project/{project-slug}/envvar","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-slug"],"properties":{"project-slug":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"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:circleci/project-get-masked-env-var":{"get":{"operationId":"open_data_circleci_project_get_masked_env_var","summary":"Get a masked environment variable","description":"GET /project/{project-slug}/envvar/{name}","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"name","in":"query","required":true,"description":"The name of the environment variable.","schema":{"type":"string","description":"The name of the environment variable."},"example":"foo"}],"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:circleci/project-delete-environment-variable":{"post":{"operationId":"open_data_circleci_project_delete_environment_variable","summary":"Delete an environment variable","description":"DELETE /project/{project-slug}/envvar/{name}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-slug","name"],"properties":{"project-slug":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"name":{"type":"string","description":"The name of the environment variable."}}}}}},"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:circleci/job-get-details":{"get":{"operationId":"open_data_circleci_job_get_details","summary":"Get job details","description":"GET /project/{project-slug}/job/{job-number}","tags":["open-data"],"parameters":[{"name":"job-number","in":"query","required":true,"description":"The number of the job.","schema":{"type":"string","description":"The number of the job."},"example":"123"},{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"}],"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:circleci/job-cancel-with-number":{"post":{"operationId":"open_data_circleci_job_cancel_with_number","summary":"Cancel job","description":"POST /project/{project-slug}/job/{job-number}/cancel","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job-number","project-slug"],"properties":{"job-number":{"type":"string","description":"The number of the job."},"project-slug":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"}}}}}},"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:circleci/pipeline-get-all-pipelines":{"get":{"operationId":"open_data_circleci_pipeline_get_all_pipelines","summary":"Get all pipelines","description":"GET /project/{project-slug}/pipeline","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"branch","in":"query","required":false,"description":"The name of a vcs branch.","schema":{"type":"string","description":"The name of a vcs branch."}},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}}],"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:circleci/pipeline-trigger-new-pipeline":{"post":{"operationId":"open_data_circleci_pipeline_trigger_new_pipeline","summary":"Trigger a new pipeline","description":"POST /project/{project-slug}/pipeline","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-slug"],"properties":{"project-slug":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"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:circleci/pipeline-list-user-pipelines":{"get":{"operationId":"open_data_circleci_pipeline_list_user_pipelines","summary":"Get your pipelines","description":"GET /project/{project-slug}/pipeline/mine","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}}],"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:circleci/pipeline-get-by-number":{"get":{"operationId":"open_data_circleci_pipeline_get_by_number","summary":"Get a pipeline by pipeline number","description":"GET /project/{project-slug}/pipeline/{pipeline-number}","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"pipeline-number","in":"query","required":true,"description":"The number of the pipeline.","schema":{"type":"string","description":"The number of the pipeline."},"example":"123"}],"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:circleci/schedule-get-all-schedules":{"get":{"operationId":"open_data_circleci_schedule_get_all_schedules","summary":"Get all schedules","description":"GET /project/{project-slug}/schedule","tags":["open-data"],"parameters":[{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"},{"name":"page-token","in":"query","required":false,"description":"A token to retrieve the next page of results.","schema":{"type":"string","description":"A token to retrieve the next page of results."}}],"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:circleci/schedule-create-new-schedule":{"post":{"operationId":"open_data_circleci_schedule_create_new_schedule","summary":"Create a schedule","description":"POST /project/{project-slug}/schedule","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-slug"],"properties":{"project-slug":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"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:circleci/job-get-artifacts":{"get":{"operationId":"open_data_circleci_job_get_artifacts","summary":"Get a job's artifacts","description":"GET /project/{project-slug}/{job-number}/artifacts","tags":["open-data"],"parameters":[{"name":"job-number","in":"query","required":true,"description":"The number of the job.","schema":{"type":"string","description":"The number of the job."},"example":"123"},{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"}],"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:circleci/job-get-test-metadata":{"get":{"operationId":"open_data_circleci_job_get_test_metadata","summary":"Get test metadata","description":"GET /project/{project-slug}/{job-number}/tests","tags":["open-data"],"parameters":[{"name":"job-number","in":"query","required":true,"description":"The number of the job.","schema":{"type":"string","description":"The number of the job."},"example":"123"},{"name":"project-slug","in":"query","required":true,"description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App,…"},"example":"gh/CircleCI-Public/api-preview-docs"}],"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:circleci/schedule-get-by-id":{"get":{"operationId":"open_data_circleci_schedule_get_by_id","summary":"Get a schedule","description":"GET /schedule/{schedule-id}","tags":["open-data"],"parameters":[{"name":"schedule-id","in":"query","required":true,"description":"The unique ID of the schedule.","schema":{"type":"string","description":"The unique ID of the schedule."}}],"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:circleci/schedule-update-schedule":{"post":{"operationId":"open_data_circleci_schedule_update_schedule","summary":"Update a schedule","description":"PATCH /schedule/{schedule-id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["schedule-id"],"properties":{"schedule-id":{"type":"string","description":"The unique ID of the schedule."},"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:circleci/schedule-remove-by-id":{"post":{"operationId":"open_data_circleci_schedule_remove_by_id","summary":"Delete a schedule","description":"DELETE /schedule/{schedule-id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["schedule-id"],"properties":{"schedule-id":{"type":"string","description":"The unique ID of the schedule."}}}}}},"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:circleci/user-get-user-information":{"get":{"operationId":"open_data_circleci_user_get_user_information","summary":"User Information","description":"GET /user/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique ID of the user.","schema":{"type":"string","description":"The unique ID of the user."}}],"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:circleci/webhook-list-matching-scope":{"get":{"operationId":"open_data_circleci_webhook_list_matching_scope","summary":"List webhooks","description":"GET /webhook","tags":["open-data"],"parameters":[{"name":"scope-id","in":"query","required":true,"description":"ID of the scope being used (at the moment, only project ID is supported)","schema":{"type":"string","description":"ID of the scope being used (at the moment, only project ID is supported)"}},{"name":"scope-type","in":"query","required":true,"description":"Type of the scope being used","schema":{"type":"string","enum":["project"],"description":"Type of the scope being used"}}],"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:circleci/webhook-create-outbound-webhook":{"post":{"operationId":"open_data_circleci_webhook_create_outbound_webhook","summary":"Create an outbound webhook","description":"POST /webhook","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:circleci/webhook-get-by-id":{"get":{"operationId":"open_data_circleci_webhook_get_by_id","summary":"Get a webhook","description":"GET /webhook/{webhook-id}","tags":["open-data"],"parameters":[{"name":"webhook-id","in":"query","required":true,"description":"ID of the webhook (UUID)","schema":{"type":"string","description":"ID of the webhook (UUID)"}}],"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:circleci/webhook-update-outbound-webhook":{"post":{"operationId":"open_data_circleci_webhook_update_outbound_webhook","summary":"Update an outbound webhook","description":"PUT /webhook/{webhook-id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhook-id"],"properties":{"webhook-id":{"type":"string","description":"ID of the webhook (UUID)"},"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:circleci/webhook-delete-outbound-webhook":{"post":{"operationId":"open_data_circleci_webhook_delete_outbound_webhook","summary":"Delete an outbound webhook","description":"DELETE /webhook/{webhook-id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhook-id"],"properties":{"webhook-id":{"type":"string","description":"ID of the webhook (UUID)"}}}}}},"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:circleci/workflow-get-by-id":{"get":{"operationId":"open_data_circleci_workflow_get_by_id","summary":"Get a workflow","description":"GET /workflow/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique ID of the workflow.","schema":{"type":"string","description":"The unique ID of the workflow."},"example":"5034460f-c7c4-4c43-9457-de07e2029e7b"}],"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:circleci/workflow-approve-job":{"post":{"operationId":"open_data_circleci_workflow_approve_job","summary":"Approve a job","description":"POST /workflow/{id}/approve/{approval_request_id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["approval_request_id","id"],"properties":{"approval_request_id":{"type":"string","description":"The ID of the job being approved."},"id":{"type":"string","description":"The unique ID of the workflow."}}}}}},"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:circleci/workflow-cancel-workflow":{"post":{"operationId":"open_data_circleci_workflow_cancel_workflow","summary":"Cancel a workflow","description":"POST /workflow/{id}/cancel","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the workflow."}}}}}},"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:circleci/workflow-get-jobs":{"get":{"operationId":"open_data_circleci_workflow_get_jobs","summary":"Get a workflow's jobs","description":"GET /workflow/{id}/job","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique ID of the workflow.","schema":{"type":"string","description":"The unique ID of the workflow."},"example":"5034460f-c7c4-4c43-9457-de07e2029e7b"}],"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:circleci/workflow-rerun-workflow":{"post":{"operationId":"open_data_circleci_workflow_rerun_workflow","summary":"Rerun a workflow","description":"POST /workflow/{id}/rerun","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the workflow."},"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:circleci/oidc-token-management-get-org-claims":{"get":{"operationId":"open_data_circleci_oidc_token_management_get_org_claims","summary":"Get org-level claims","description":"GET /org/{orgID}/oidc-custom-claims","tags":["open-data"],"parameters":[{"name":"orgID","in":"query","required":true,"schema":{"type":"string"}}],"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:circleci/oidc-token-management-update-org-claims":{"post":{"operationId":"open_data_circleci_oidc_token_management_update_org_claims","summary":"Patch org-level claims","description":"PATCH /org/{orgID}/oidc-custom-claims","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orgID"],"properties":{"orgID":{"type":"string"},"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:circleci/oidc-token-management-delete-org-claims":{"post":{"operationId":"open_data_circleci_oidc_token_management_delete_org_claims","summary":"Delete org-level claims","description":"DELETE /org/{orgID}/oidc-custom-claims","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orgID","claims"],"properties":{"orgID":{"type":"string"},"claims":{"type":"string","description":"comma separated list of claims to delete. Valid values are \"audience\" and \"ttl\"."}}}}}},"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:circleci/oidc-token-management-get-project-claims":{"get":{"operationId":"open_data_circleci_oidc_token_management_get_project_claims","summary":"Get project-level claims","description":"GET /org/{orgID}/project/{projectID}/oidc-custom-claims","tags":["open-data"],"parameters":[{"name":"orgID","in":"query","required":true,"schema":{"type":"string"}},{"name":"projectID","in":"query","required":true,"schema":{"type":"string"}}],"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:circleci/oidc-token-management-update-project-claims":{"post":{"operationId":"open_data_circleci_oidc_token_management_update_project_claims","summary":"Patch project-level claims","description":"PATCH /org/{orgID}/project/{projectID}/oidc-custom-claims","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orgID","projectID"],"properties":{"orgID":{"type":"string"},"projectID":{"type":"string"},"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:circleci/oidc-token-management-delete-project-claims":{"post":{"operationId":"open_data_circleci_oidc_token_management_delete_project_claims","summary":"Delete project-level claims","description":"DELETE /org/{orgID}/project/{projectID}/oidc-custom-claims","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orgID","projectID","claims"],"properties":{"orgID":{"type":"string"},"projectID":{"type":"string"},"claims":{"type":"string","description":"comma separated list of claims to delete. Valid values are \"audience\" and \"ttl\"."}}}}}},"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:circleci/policy-management-get-decision-audit-logs":{"get":{"operationId":"open_data_circleci_policy_management_get_decision_audit_logs","summary":"Retrieves the owner's decision audit logs.","description":"GET /owner/{ownerID}/context/{context}/decision","tags":["open-data"],"parameters":[{"name":"ownerID","in":"query","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"Return decisions matching this decision status.","schema":{"type":"string","description":"Return decisions matching this decision status."}},{"name":"after","in":"query","required":false,"description":"Return decisions made after this date.","schema":{"type":"string","description":"Return decisions made after this date."}},{"name":"before","in":"query","required":false,"description":"Return decisions made before this date.","schema":{"type":"string","description":"Return decisions made before this date."}},{"name":"branch","in":"query","required":false,"description":"Return decisions made on this branch.","schema":{"type":"string","description":"Return decisions made on this branch."}},{"name":"project_id","in":"query","required":false,"description":"Return decisions made for this project.","schema":{"type":"string","description":"Return decisions made for this project."}},{"name":"build_number","in":"query","required":false,"description":"Return decisions made for this build number.","schema":{"type":"string","description":"Return decisions made for this build number."}},{"name":"offset","in":"query","required":false,"description":"Sets the offset when retrieving the decisions, for paging.","schema":{"type":"integer","description":"Sets the offset when retrieving the decisions, for paging."}}],"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:circleci/policy-management-evaluate-input-data":{"post":{"operationId":"open_data_circleci_policy_management_evaluate_input_data","summary":"Makes a decision","description":"POST /owner/{ownerID}/context/{context}/decision","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ownerID","context"],"properties":{"ownerID":{"type":"string"},"context":{"type":"string"},"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:circleci/policy-management-get-decision-settings":{"get":{"operationId":"open_data_circleci_policy_management_get_decision_settings","summary":"Get the decision settings","description":"GET /owner/{ownerID}/context/{context}/decision/settings","tags":["open-data"],"parameters":[{"name":"ownerID","in":"query","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","required":true,"schema":{"type":"string"}}],"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:circleci/policy-management-modify-decision-settings":{"post":{"operationId":"open_data_circleci_policy_management_modify_decision_settings","summary":"Set the decision settings","description":"PATCH /owner/{ownerID}/context/{context}/decision/settings","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ownerID","context"],"properties":{"ownerID":{"type":"string"},"context":{"type":"string"},"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:circleci/policy-management-get-decision-audit-log-by-given-id":{"get":{"operationId":"open_data_circleci_policy_management_get_decision_audit_log_by_given_id","summary":"Retrieves the owner's decision audit log by given decisionID","description":"GET /owner/{ownerID}/context/{context}/decision/{decisionID}","tags":["open-data"],"parameters":[{"name":"ownerID","in":"query","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","required":true,"schema":{"type":"string"}},{"name":"decisionID","in":"query","required":true,"schema":{"type":"string"}}],"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:circleci/policy-management-get-policy-bundle-for-decision":{"get":{"operationId":"open_data_circleci_policy_management_get_policy_bundle_for_decision","summary":"Retrieves Policy Bundle for a given decision log ID","description":"GET /owner/{ownerID}/context/{context}/decision/{decisionID}/policy-bundle","tags":["open-data"],"parameters":[{"name":"ownerID","in":"query","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","required":true,"schema":{"type":"string"}},{"name":"decisionID","in":"query","required":true,"schema":{"type":"string"}}],"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:circleci/policy-management-get-policy-bundle":{"get":{"operationId":"open_data_circleci_policy_management_get_policy_bundle","summary":"Retrieves Policy Bundle","description":"GET /owner/{ownerID}/context/{context}/policy-bundle","tags":["open-data"],"parameters":[{"name":"ownerID","in":"query","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","required":true,"schema":{"type":"string"}}],"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:circleci/policy-management-create-policy-bundle-for-context":{"post":{"operationId":"open_data_circleci_policy_management_create_policy_bundle_for_context","summary":"Creates policy bundle for the context","description":"POST /owner/{ownerID}/context/{context}/policy-bundle","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ownerID","context"],"properties":{"ownerID":{"type":"string"},"context":{"type":"string"},"dry":{"type":"boolean"},"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:circleci/policy-management-get-document":{"get":{"operationId":"open_data_circleci_policy_management_get_document","summary":"Retrieves a policy document","description":"GET /owner/{ownerID}/context/{context}/policy-bundle/{policyName}","tags":["open-data"],"parameters":[{"name":"ownerID","in":"query","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","required":true,"schema":{"type":"string"}},{"name":"policyName","in":"query","required":true,"description":"the policy name set by the rego policy_name rule","schema":{"type":"string","description":"the policy name set by the rego policy_name rule"}}],"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:circleci/context-get-restrictions":{"get":{"operationId":"open_data_circleci_context_get_restrictions","summary":"🧪 Get context restrictions","description":"GET /context/{context_id}/restrictions","tags":["open-data"],"parameters":[{"name":"context_id","in":"query","required":true,"description":"An opaque identifier of a context.","schema":{"type":"string","description":"An opaque identifier of a context."},"example":"be8bb2e3-c3d6-4098-89f4-572ff976ba9a"}],"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:circleci/context-create-restriction":{"post":{"operationId":"open_data_circleci_context_create_restriction","summary":"🧪 Create context restriction","description":"POST /context/{context_id}/restrictions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["context_id","body"],"properties":{"context_id":{"type":"string","description":"An opaque identifier of a context."},"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:circleci/context-delete-restriction":{"post":{"operationId":"open_data_circleci_context_delete_restriction","summary":"🧪 Delete context restriction","description":"DELETE /context/{context_id}/restrictions/{restriction_id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["context_id","restriction_id"],"properties":{"context_id":{"type":"string","description":"An opaque identifier of a context."},"restriction_id":{"type":"string","description":"An opaque identifier of a context restriction."}}}}}},"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:circleci/project-create-project-default-settings":{"post":{"operationId":"open_data_circleci_project_create_project_default_settings","summary":"🧪 Create a project","description":"POST /project/{provider}/{organization}/{project}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["provider","organization","project"],"properties":{"provider":{"type":"string","description":"The `provider` segment of a project or org slug, the first of the three. This may be a VCS. For projects that use GitLab or GitHub App,…"},"organization":{"type":"string","description":"The `organization` segment of a project or org slug, the second of the three. For GitHub OAuth or Bitbucket projects, this is the…"},"project":{"type":"string","description":"The `project` segment of a project slug, the third of the three. For GitHub OAuth or Bitbucket projects, this is the repository name. For…"}}}}}},"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:circleci/project-get-settings":{"get":{"operationId":"open_data_circleci_project_get_settings","summary":"🧪 Get project settings","description":"GET /project/{provider}/{organization}/{project}/settings","tags":["open-data"],"parameters":[{"name":"provider","in":"query","required":true,"description":"The `provider` segment of a project or org slug, the first of the three. This may be a VCS. For projects that use GitLab or GitHub App,…","schema":{"type":"string","description":"The `provider` segment of a project or org slug, the first of the three. This may be a VCS. For projects that use GitLab or GitHub App,…"},"example":"gh"},{"name":"organization","in":"query","required":true,"description":"The `organization` segment of a project or org slug, the second of the three. For GitHub OAuth or Bitbucket projects, this is the…","schema":{"type":"string","description":"The `organization` segment of a project or org slug, the second of the three. For GitHub OAuth or Bitbucket projects, this is the…"},"example":"CircleCI-Public"},{"name":"project","in":"query","required":true,"description":"The `project` segment of a project slug, the third of the three. For GitHub OAuth or Bitbucket projects, this is the repository name. For…","schema":{"type":"string","description":"The `project` segment of a project slug, the third of the three. For GitHub OAuth or Bitbucket projects, this is the repository name. For…"},"example":"api-preview-docs"}],"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:circleci/project-update-settings":{"post":{"operationId":"open_data_circleci_project_update_settings","summary":"🧪 Update project settings","description":"PATCH /project/{provider}/{organization}/{project}/settings","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["provider","organization","project","body"],"properties":{"provider":{"type":"string","description":"The `provider` segment of a project or org slug, the first of the three. This may be a VCS. For projects that use GitLab or GitHub App,…"},"organization":{"type":"string","description":"The `organization` segment of a project or org slug, the second of the three. For GitHub OAuth or Bitbucket projects, this is the…"},"project":{"type":"string","description":"The `project` segment of a project slug, the third of the three. For GitHub OAuth or Bitbucket projects, this is the repository name. For…"},"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"}}}}}}}