Skip to main content
Server path: /circleci-projects | Type: Application | PCID required: Yes

Tools

ToolDescription
circleci_projects_add_environment_variable_to_contextAdd or update an environment variable
circleci_projects_create_checkout_keyCreate a new checkout key
circleci_projects_create_contextCreate a new context
circleci_projects_create_context_restrictionCreate context restriction
circleci_projects_create_env_varCreate an environment variable
circleci_projects_create_projectCreate a new project
circleci_projects_create_usage_exportCreate a usage export
circleci_projects_delete_checkout_keyDelete a checkout key
circleci_projects_delete_contextDelete a context
circleci_projects_delete_context_restrictionDelete context restriction
circleci_projects_delete_env_varDelete an environment variable
circleci_projects_delete_environment_variable_from_contextRemove an environment variable
circleci_projects_delete_project_by_slugDelete a project
circleci_projects_get_all_insights_branchesGet all branches for a project
circleci_projects_get_checkout_keyGet a checkout key
circleci_projects_get_contextGet a context
circleci_projects_get_context_restrictionsGet context restrictions
circleci_projects_get_env_varGet a masked environment variable
circleci_projects_get_flaky_testsGet flaky tests for a project
circleci_projects_get_job_timeseriesJob timeseries data
circleci_projects_get_org_summary_dataGet summary metrics with trends for the entire org, and for each project.
circleci_projects_get_project_by_slugGet a project
circleci_projects_get_project_settingsGet project settings
circleci_projects_get_project_workflow_job_metricsGet summary metrics for a project workflow’s jobs.
circleci_projects_get_project_workflow_metricsGet summary metrics for a project’s workflows
circleci_projects_get_project_workflow_runsGet recent runs of a workflow
circleci_projects_get_project_workflow_test_metricsGet test metrics for a project’s workflows
circleci_projects_get_project_workflows_page_dataGet summary metrics and trends for a project across it’s workflows and branches
circleci_projects_get_usage_exportGet a usage export
circleci_projects_get_workflow_summaryGet metrics and trends for workflows
circleci_projects_list_checkout_keysGet all checkout keys
circleci_projects_list_contextsList contexts
circleci_projects_list_env_varsList all environment variables
circleci_projects_list_environment_variables_from_contextList environment variables
circleci_projects_patch_project_settingsUpdate project settings

circleci_projects_add_environment_variable_to_context

Add or update an environment variable Parameters:
ParameterTypeRequiredDefaultDescription
context_idstringYesAn opaque identifier of a context.
env_var_namestringYesThe name of the environment variable.
valuestringYesThe value of the environment variable

circleci_projects_create_checkout_key

Create a new checkout key Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
typestringYesThe type of checkout key to create. This may be either deploy-key or user-key.

circleci_projects_create_context

Create a new context Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe user defined name of the context.
ownerobjectYesThe owner value

circleci_projects_create_context_restriction

Create context restriction Parameters:
ParameterTypeRequiredDefaultDescription
context_idstringYesAn opaque identifier of a context.
restriction_typestringNoType of the restriction.
restriction_valuestringNoValue used to evaluate the restriction. If the restriction_type is project, this will be the project UUID. If the restriction_type is expression, this will be the expression rule.

circleci_projects_create_env_var

Create an environment variable Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
namestringYesThe name of the environment variable.
valuestringYesThe value of the environment variable.

circleci_projects_create_project

Create a new project Parameters:
ParameterTypeRequiredDefaultDescription
org-slug-or-idstringYesOrg UUID or 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 org-name with the organization ID (found in Organization Settings).
namestringYesThe name of the project

circleci_projects_create_usage_export

Create a usage export Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesAn opaque identifier of an organization.
endstringYesThe end date & time (inclusive) of the range from which data will be pulled. Must be no more than 31 days after start.
shared_org_idsstring[]NoShared Org Ids
startstringYesThe start date & time (inclusive) of the range from which data will be pulled. Must be no more than one year ago.

circleci_projects_delete_checkout_key

Delete a checkout key Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
fingerprintstringYesAn SSH key fingerprint.

circleci_projects_delete_context

Delete a context Parameters:
ParameterTypeRequiredDefaultDescription
context_idstringYesAn opaque identifier of a context.

circleci_projects_delete_context_restriction

Delete context restriction Parameters:
ParameterTypeRequiredDefaultDescription
context_idstringYesAn opaque identifier of a context.
restriction_idstringYesAn opaque identifier of a context restriction.

circleci_projects_delete_env_var

Delete an environment variable Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
namestringYesThe name of the environment variable.

circleci_projects_delete_environment_variable_from_context

Remove an environment variable Parameters:
ParameterTypeRequiredDefaultDescription
context_idstringYesAn opaque identifier of a context.
env_var_namestringYesThe name of the environment variable.

circleci_projects_delete_project_by_slug

Delete a project Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

circleci_projects_get_all_insights_branches

Get all branches for a project Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
workflow-namestringNoThe name of a workflow. If not passed we will scope the API call to the project.

circleci_projects_get_checkout_key

Get a checkout key Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
fingerprintstringYesAn SSH key fingerprint.

circleci_projects_get_context

Get a context Parameters:
ParameterTypeRequiredDefaultDescription
context_idstringYesAn opaque identifier of a context.

circleci_projects_get_context_restrictions

Get context restrictions Parameters:
ParameterTypeRequiredDefaultDescription
context_idstringYesAn opaque identifier of a context.

circleci_projects_get_env_var

Get a masked environment variable Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
namestringYesThe name of the environment variable.

circleci_projects_get_flaky_tests

Get flaky tests for a project Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

circleci_projects_get_job_timeseries

Job timeseries data Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
workflow-namestringYesThe name of the workflow.
branchstringNoThe name of a vcs branch. If not passed we will scope the API call to the default branch.
granularitystringNoThe granularity for which to query timeseries data.
start-datestringNoInclude only executions that started at or after this date. This must be specified if an end-date is provided.
end-datestringNoInclude only executions that started before this date. This date can be at most 90 days after the start-date.

circleci_projects_get_org_summary_data

Get summary metrics with trends for the entire org, and for each project. Parameters:
ParameterTypeRequiredDefaultDescription
org-slugstringYesOrg slug in the form vcs-slug/org-name. The / characters may be URL-escaped.
reporting-windowstringNoThe time window used to calculate summary metrics. If not provided, defaults to last-90-days
project-namesobjectNoList of project names.

circleci_projects_get_project_by_slug

Get a project Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

circleci_projects_get_project_settings

Get project settings Parameters:
ParameterTypeRequiredDefaultDescription
providerstringYesThe first segment of the slash-separated project slug, as shown in Project Settings > Overview.
organizationstringYesThe second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. my-org) or an ID (e.g. 43G3lM5RtfFE7v5sa4nWAU).
projectstringYesThe third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. my-project) or an ID (e.g. 44n9wujWcTnVZ2b5S8Fnat).

circleci_projects_get_project_workflow_job_metrics

Get summary metrics for a project workflow’s jobs. Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
workflow-namestringYesThe name of the workflow.
page-tokenstringNoA token to retrieve the next page of results.
all-branchesbooleanNoWhether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.
branchstringNoThe name of a vcs branch. If not passed we will scope the API call to the default branch.
reporting-windowstringNoThe time window used to calculate summary metrics. If not provided, defaults to last-90-days
job-namestringNoThe name of the jobs you would like to filter from your workflow. If not specified, all workflow jobs will be returned. The job name can either be the full job name or just a substring of the job name.

circleci_projects_get_project_workflow_metrics

Get summary metrics for a project’s workflows Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
page-tokenstringNoA token to retrieve the next page of results.
all-branchesbooleanNoWhether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.
branchstringNoThe name of a vcs branch. If not passed we will scope the API call to the default branch.
reporting-windowstringNoThe time window used to calculate summary metrics. If not provided, defaults to last-90-days

circleci_projects_get_project_workflow_runs

Get recent runs of a workflow Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
workflow-namestringYesThe name of the workflow.
all-branchesbooleanNoWhether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.
branchstringNoThe name of a vcs branch. If not passed we will scope the API call to the default branch.
page-tokenstringNoA token to retrieve the next page of results.
start-datestringNoInclude only executions that started at or after this date. This must be specified if an end-date is provided.
end-datestringNoInclude only executions that started before this date. This date can be at most 90 days after the start-date.

circleci_projects_get_project_workflow_test_metrics

Get test metrics for a project’s workflows Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
workflow-namestringYesThe name of the workflow.
branchstringNoThe name of a vcs branch. If not passed we will scope the API call to the default branch.
all-branchesbooleanNoWhether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.

circleci_projects_get_project_workflows_page_data

Get summary metrics and trends for a project across it’s workflows and branches Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
reporting-windowstringNoThe time window used to calculate summary metrics. If not provided, defaults to last-90-days
branchesobjectNoThe names of VCS branches to include in branch-level workflow metrics.
workflow-namesobjectNoThe names of workflows to include in workflow-level metrics.

circleci_projects_get_usage_export

Get a usage export Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesAn opaque identifier of an organization.
usage_export_job_idstringYesAn opaque identifier of a usage export job.

circleci_projects_get_workflow_summary

Get metrics and trends for workflows Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
workflow-namestringYesThe name of the workflow.
all-branchesbooleanNoWhether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.
branchstringNoThe name of a vcs branch. If not passed we will scope the API call to the default branch.

circleci_projects_list_checkout_keys

Get all checkout keys Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
digeststringNoThe fingerprint digest type to return. This may be either md5 or sha256. If not passed, defaults to md5.

circleci_projects_list_contexts

List contexts Parameters:
ParameterTypeRequiredDefaultDescription
owner-idstringNoThe unique ID of the owner of the context. This is the organization ID. Specify either owner/organization ID or the owner/organization slug. Find the organization ID and slug in the CircleCI web app (Organization Settings > Overview). Owner/organization slug is not supported for CircleCI server.
owner-slugstringNoA string that represents an organization. This is the organization slug. Specify either this or organization/owner ID. Find the organization ID and slug in the CircleCI web app (Organization Settings > Overview). Owner/organization slug is not supported for CircleCI server.
owner-typestringNoThe type of the owner. Defaults to “organization”. Use “account” if you are using CircleCI server.
page-tokenstringNoA token to specify which page of results to fetch.

circleci_projects_list_env_vars

List all environment variables Parameters:
ParameterTypeRequiredDefaultDescription
project-slugstringYesProject slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

circleci_projects_list_environment_variables_from_context

List environment variables Parameters:
ParameterTypeRequiredDefaultDescription
context_idstringYesAn opaque identifier of a context.
page-tokenstringNoA token to specify which page of results to fetch.

circleci_projects_patch_project_settings

Update project settings Parameters:
ParameterTypeRequiredDefaultDescription
providerstringYesThe first segment of the slash-separated project slug, as shown in Project Settings > Overview.
organizationstringYesThe second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. my-org) or an ID (e.g. 43G3lM5RtfFE7v5sa4nWAU).
projectstringYesThe third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. my-project) or an ID (e.g. 44n9wujWcTnVZ2b5S8Fnat).
advancedobjectNoThe advanced value