/circleci-projects | Type: Application | PCID required: Yes
Tools
circleci_projects_add_environment_variable_to_context
Add or update an environment variable Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
context_id | string | Yes | — | An opaque identifier of a context. |
env_var_name | string | Yes | — | The name of the environment variable. |
value | string | Yes | — | The value of the environment variable |
circleci_projects_create_checkout_key
Create a new checkout key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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). |
type | string | Yes | — | The type of checkout key to create. This may be either deploy-key or user-key. |
circleci_projects_create_context
Create a new context Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The user defined name of the context. |
owner | object | Yes | — | The owner value |
circleci_projects_create_context_restriction
Create context restriction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
context_id | string | Yes | — | An opaque identifier of a context. |
restriction_type | string | No | — | Type of the restriction. |
restriction_value | string | No | — | Value 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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). |
name | string | Yes | — | The name of the environment variable. |
value | string | Yes | — | The value of the environment variable. |
circleci_projects_create_project
Create a new project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org-slug-or-id | string | Yes | — | Org 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). |
name | string | Yes | — | The name of the project |
circleci_projects_create_usage_export
Create a usage export Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | An opaque identifier of an organization. |
end | string | Yes | — | The end date & time (inclusive) of the range from which data will be pulled. Must be no more than 31 days after start. |
shared_org_ids | string[] | No | — | Shared Org Ids |
start | string | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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). |
fingerprint | string | Yes | — | An SSH key fingerprint. |
circleci_projects_delete_context
Delete a context Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
context_id | string | Yes | — | An opaque identifier of a context. |
circleci_projects_delete_context_restriction
Delete context restriction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
context_id | string | Yes | — | An opaque identifier of a context. |
restriction_id | string | Yes | — | An opaque identifier of a context restriction. |
circleci_projects_delete_env_var
Delete an environment variable Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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). |
name | string | Yes | — | The name of the environment variable. |
circleci_projects_delete_environment_variable_from_context
Remove an environment variable Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
context_id | string | Yes | — | An opaque identifier of a context. |
env_var_name | string | Yes | — | The name of the environment variable. |
circleci_projects_delete_project_by_slug
Delete a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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-name | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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). |
fingerprint | string | Yes | — | An SSH key fingerprint. |
circleci_projects_get_context
Get a context Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
context_id | string | Yes | — | An opaque identifier of a context. |
circleci_projects_get_context_restrictions
Get context restrictions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
context_id | string | Yes | — | An opaque identifier of a context. |
circleci_projects_get_env_var
Get a masked environment variable Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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). |
name | string | Yes | — | The name of the environment variable. |
circleci_projects_get_flaky_tests
Get flaky tests for a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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-name | string | Yes | — | The name of the workflow. |
branch | string | No | — | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
granularity | string | No | — | The granularity for which to query timeseries data. |
start-date | string | No | — | Include only executions that started at or after this date. This must be specified if an end-date is provided. |
end-date | string | No | — | Include 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org-slug | string | Yes | — | Org slug in the form vcs-slug/org-name. The / characters may be URL-escaped. |
reporting-window | string | No | — | The time window used to calculate summary metrics. If not provided, defaults to last-90-days |
project-names | object | No | — | List of project names. |
circleci_projects_get_project_by_slug
Get a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
provider | string | Yes | — | The first segment of the slash-separated project slug, as shown in Project Settings > Overview. |
organization | string | Yes | — | The 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). |
project | string | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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-name | string | Yes | — | The name of the workflow. |
page-token | string | No | — | A token to retrieve the next page of results. |
all-branches | boolean | No | — | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
branch | string | No | — | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
reporting-window | string | No | — | The time window used to calculate summary metrics. If not provided, defaults to last-90-days |
job-name | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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-token | string | No | — | A token to retrieve the next page of results. |
all-branches | boolean | No | — | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
branch | string | No | — | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
reporting-window | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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-name | string | Yes | — | The name of the workflow. |
all-branches | boolean | No | — | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
branch | string | No | — | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
page-token | string | No | — | A token to retrieve the next page of results. |
start-date | string | No | — | Include only executions that started at or after this date. This must be specified if an end-date is provided. |
end-date | string | No | — | Include 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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-name | string | Yes | — | The name of the workflow. |
branch | string | No | — | The name of a vcs branch. If not passed we will scope the API call to the default branch. |
all-branches | boolean | No | — | Whether 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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-window | string | No | — | The time window used to calculate summary metrics. If not provided, defaults to last-90-days |
branches | object | No | — | The names of VCS branches to include in branch-level workflow metrics. |
workflow-names | object | No | — | The names of workflows to include in workflow-level metrics. |
circleci_projects_get_usage_export
Get a usage export Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | An opaque identifier of an organization. |
usage_export_job_id | string | Yes | — | An opaque identifier of a usage export job. |
circleci_projects_get_workflow_summary
Get metrics and trends for workflows Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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-name | string | Yes | — | The name of the workflow. |
all-branches | boolean | No | — | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. |
branch | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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). |
digest | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
owner-id | string | No | — | The 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-slug | string | No | — | A 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-type | string | No | — | The type of the owner. Defaults to “organization”. Use “account” if you are using CircleCI server. |
page-token | string | No | — | A token to specify which page of results to fetch. |
circleci_projects_list_env_vars
List all environment variables Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project-slug | string | Yes | — | 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, 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
context_id | string | Yes | — | An opaque identifier of a context. |
page-token | string | No | — | A token to specify which page of results to fetch. |
circleci_projects_patch_project_settings
Update project settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
provider | string | Yes | — | The first segment of the slash-separated project slug, as shown in Project Settings > Overview. |
organization | string | Yes | — | The 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). |
project | string | Yes | — | The 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). |
advanced | object | No | — | The advanced value |

