> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# circleci-projects
> CircleCI Projects - projects, insights, usage, and context variables
**Server path:** `/circleci-projects` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [`circleci_projects_add_environment_variable_to_context`](#circleci_projects_add_environment_variable_to_context) | Add or update an environment variable |
| [`circleci_projects_create_checkout_key`](#circleci_projects_create_checkout_key) | Create a new checkout key |
| [`circleci_projects_create_context`](#circleci_projects_create_context) | Create a new context |
| [`circleci_projects_create_context_restriction`](#circleci_projects_create_context_restriction) | Create context restriction |
| [`circleci_projects_create_env_var`](#circleci_projects_create_env_var) | Create an environment variable |
| [`circleci_projects_create_project`](#circleci_projects_create_project) | Create a new project |
| [`circleci_projects_create_usage_export`](#circleci_projects_create_usage_export) | Create a usage export |
| [`circleci_projects_delete_checkout_key`](#circleci_projects_delete_checkout_key) | Delete a checkout key |
| [`circleci_projects_delete_context`](#circleci_projects_delete_context) | Delete a context |
| [`circleci_projects_delete_context_restriction`](#circleci_projects_delete_context_restriction) | Delete context restriction |
| [`circleci_projects_delete_env_var`](#circleci_projects_delete_env_var) | Delete an environment variable |
| [`circleci_projects_delete_environment_variable_from_context`](#circleci_projects_delete_environment_variable_from_context) | Remove an environment variable |
| [`circleci_projects_delete_project_by_slug`](#circleci_projects_delete_project_by_slug) | Delete a project |
| [`circleci_projects_get_all_insights_branches`](#circleci_projects_get_all_insights_branches) | Get all branches for a project |
| [`circleci_projects_get_checkout_key`](#circleci_projects_get_checkout_key) | Get a checkout key |
| [`circleci_projects_get_context`](#circleci_projects_get_context) | Get a context |
| [`circleci_projects_get_context_restrictions`](#circleci_projects_get_context_restrictions) | Get context restrictions |
| [`circleci_projects_get_env_var`](#circleci_projects_get_env_var) | Get a masked environment variable |
| [`circleci_projects_get_flaky_tests`](#circleci_projects_get_flaky_tests) | Get flaky tests for a project |
| [`circleci_projects_get_job_timeseries`](#circleci_projects_get_job_timeseries) | Job timeseries data |
| [`circleci_projects_get_org_summary_data`](#circleci_projects_get_org_summary_data) | Get summary metrics with trends for the entire org, and for each project. |
| [`circleci_projects_get_project_by_slug`](#circleci_projects_get_project_by_slug) | Get a project |
| [`circleci_projects_get_project_settings`](#circleci_projects_get_project_settings) | Get project settings |
| [`circleci_projects_get_project_workflow_job_metrics`](#circleci_projects_get_project_workflow_job_metrics) | Get summary metrics for a project workflow's jobs. |
| [`circleci_projects_get_project_workflow_metrics`](#circleci_projects_get_project_workflow_metrics) | Get summary metrics for a project's workflows |
| [`circleci_projects_get_project_workflow_runs`](#circleci_projects_get_project_workflow_runs) | Get recent runs of a workflow |
| [`circleci_projects_get_project_workflow_test_metrics`](#circleci_projects_get_project_workflow_test_metrics) | Get test metrics for a project's workflows |
| [`circleci_projects_get_project_workflows_page_data`](#circleci_projects_get_project_workflows_page_data) | Get summary metrics and trends for a project across it's workflows and branches |
| [`circleci_projects_get_usage_export`](#circleci_projects_get_usage_export) | Get a usage export |
| [`circleci_projects_get_workflow_summary`](#circleci_projects_get_workflow_summary) | Get metrics and trends for workflows |
| [`circleci_projects_list_checkout_keys`](#circleci_projects_list_checkout_keys) | Get all checkout keys |
| [`circleci_projects_list_contexts`](#circleci_projects_list_contexts) | List contexts |
| [`circleci_projects_list_env_vars`](#circleci_projects_list_env_vars) | List all environment variables |
| [`circleci_projects_list_environment_variables_from_context`](#circleci_projects_list_environment_variables_from_context) | List environment variables |
| [`circleci_projects_patch_project_settings`](#circleci_projects_patch_project_settings) | Update project settings |
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"context_id": {
"type": "string",
"description": "An opaque identifier of a context."
},
"env_var_name": {
"type": "string",
"description": "The name of the environment variable."
},
"value": {
"type": "string",
"description": "The value of the environment variable"
}
},
"required": [
"PCID",
"context_id",
"env_var_name",
"value"
]
}
```
***
## 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`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The type of checkout key to create. This may be either `deploy-key` or `user-key`.",
"enum": [
"user-key",
"deploy-key"
]
}
},
"required": [
"PCID",
"project-slug",
"type"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The user defined name of the context."
},
"owner": {
"description": "The owner value"
}
},
"required": [
"PCID",
"name",
"owner"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"context_id": {
"type": "string",
"description": "An opaque identifier of a context."
},
"restriction_type": {
"type": "string",
"description": "Type of the restriction.",
"enum": [
"project",
"expression",
"group"
]
},
"restriction_value": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"context_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The name of the environment variable."
},
"value": {
"type": "string",
"description": "The value of the environment variable."
}
},
"required": [
"PCID",
"project-slug",
"name",
"value"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org-slug-or-id": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The name of the project"
}
},
"required": [
"PCID",
"org-slug-or-id",
"name"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "An opaque identifier of an organization."
},
"end": {
"type": "string",
"description": "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": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Shared Org Ids"
},
"start": {
"type": "string",
"description": "The start date & time (inclusive) of the range from which data will be pulled. Must be no more than one year ago."
}
},
"required": [
"PCID",
"org_id",
"end",
"start"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "An SSH key fingerprint."
}
},
"required": [
"PCID",
"project-slug",
"fingerprint"
]
}
```
***
## circleci\_projects\_delete\_context
Delete a context
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------- |
| `context_id` | string | Yes | — | An opaque identifier of a context. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"context_id": {
"type": "string",
"description": "An opaque identifier of a context."
}
},
"required": [
"PCID",
"context_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"context_id": {
"type": "string",
"description": "An opaque identifier of a context."
},
"restriction_id": {
"type": "string",
"description": "An opaque identifier of a context restriction."
}
},
"required": [
"PCID",
"context_id",
"restriction_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The name of the environment variable."
}
},
"required": [
"PCID",
"project-slug",
"name"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"context_id": {
"type": "string",
"description": "An opaque identifier of a context."
},
"env_var_name": {
"type": "string",
"description": "The name of the environment variable."
}
},
"required": [
"PCID",
"context_id",
"env_var_name"
]
}
```
***
## 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). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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)."
}
},
"required": [
"PCID",
"project-slug"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The name of a workflow. If not passed we will scope the API call to the project."
}
},
"required": [
"PCID",
"project-slug"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "An SSH key fingerprint."
}
},
"required": [
"PCID",
"project-slug",
"fingerprint"
]
}
```
***
## circleci\_projects\_get\_context
Get a context
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------- |
| `context_id` | string | Yes | — | An opaque identifier of a context. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"context_id": {
"type": "string",
"description": "An opaque identifier of a context."
}
},
"required": [
"PCID",
"context_id"
]
}
```
***
## circleci\_projects\_get\_context\_restrictions
Get context restrictions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------- |
| `context_id` | string | Yes | — | An opaque identifier of a context. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"context_id": {
"type": "string",
"description": "An opaque identifier of a context."
}
},
"required": [
"PCID",
"context_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The name of the environment variable."
}
},
"required": [
"PCID",
"project-slug",
"name"
]
}
```
***
## 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). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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)."
}
},
"required": [
"PCID",
"project-slug"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The name of the workflow."
},
"branch": {
"type": "string",
"description": "The name of a vcs branch. If not passed we will scope the API call to the default branch."
},
"granularity": {
"type": "string",
"description": "The granularity for which to query timeseries data.",
"enum": [
"daily",
"hourly"
]
},
"start-date": {
"type": "string",
"description": "Include only executions that started at or after this date. This must be specified if an end-date is provided."
},
"end-date": {
"type": "string",
"description": "Include only executions that started before this date. This date can be at most 90 days after the start-date."
}
},
"required": [
"PCID",
"project-slug",
"workflow-name"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org-slug": {
"type": "string",
"description": "Org slug in the form `vcs-slug/org-name`. The `/` characters may be URL-escaped."
},
"reporting-window": {
"type": "string",
"description": "The time window used to calculate summary metrics. If not provided, defaults to last-90-days",
"enum": [
"last-7-days",
"last-90-days",
"last-24-hours",
"last-30-days",
"last-60-days"
]
},
"project-names": {
"type": "object",
"description": "List of project names."
}
},
"required": [
"PCID",
"org-slug"
]
}
```
***
## 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). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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)."
}
},
"required": [
"PCID",
"project-slug"
]
}
```
***
## 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`). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"provider": {
"type": "string",
"description": "The first segment of the slash-separated project slug, as shown in Project Settings > Overview.",
"enum": [
"github",
"gh",
"bitbucket",
"bb",
"circleci"
]
},
"organization": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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`)."
}
},
"required": [
"PCID",
"provider",
"organization",
"project"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The name of the workflow."
},
"page-token": {
"type": "string",
"description": "A token to retrieve the next page of results."
},
"all-branches": {
"type": "boolean",
"description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."
},
"branch": {
"type": "string",
"description": "The name of a vcs branch. If not passed we will scope the API call to the default branch."
},
"reporting-window": {
"type": "string",
"description": "The time window used to calculate summary metrics. If not provided, defaults to last-90-days",
"enum": [
"last-7-days",
"last-90-days",
"last-24-hours",
"last-30-days",
"last-60-days"
]
},
"job-name": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"project-slug",
"workflow-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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "A token to retrieve the next page of results."
},
"all-branches": {
"type": "boolean",
"description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."
},
"branch": {
"type": "string",
"description": "The name of a vcs branch. If not passed we will scope the API call to the default branch."
},
"reporting-window": {
"type": "string",
"description": "The time window used to calculate summary metrics. If not provided, defaults to last-90-days",
"enum": [
"last-7-days",
"last-90-days",
"last-24-hours",
"last-30-days",
"last-60-days"
]
}
},
"required": [
"PCID",
"project-slug"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The name of the workflow."
},
"all-branches": {
"type": "boolean",
"description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."
},
"branch": {
"type": "string",
"description": "The name of a vcs branch. If not passed we will scope the API call to the default branch."
},
"page-token": {
"type": "string",
"description": "A token to retrieve the next page of results."
},
"start-date": {
"type": "string",
"description": "Include only executions that started at or after this date. This must be specified if an end-date is provided."
},
"end-date": {
"type": "string",
"description": "Include only executions that started before this date. This date can be at most 90 days after the start-date."
}
},
"required": [
"PCID",
"project-slug",
"workflow-name"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The name of the workflow."
},
"branch": {
"type": "string",
"description": "The name of a vcs branch. If not passed we will scope the API call to the default branch."
},
"all-branches": {
"type": "boolean",
"description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."
}
},
"required": [
"PCID",
"project-slug",
"workflow-name"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The time window used to calculate summary metrics. If not provided, defaults to last-90-days",
"enum": [
"last-7-days",
"last-90-days",
"last-24-hours",
"last-30-days",
"last-60-days"
]
},
"branches": {
"type": "object",
"description": "The names of VCS branches to include in branch-level workflow metrics."
},
"workflow-names": {
"type": "object",
"description": "The names of workflows to include in workflow-level metrics."
}
},
"required": [
"PCID",
"project-slug"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "An opaque identifier of an organization."
},
"usage_export_job_id": {
"type": "string",
"description": "An opaque identifier of a usage export job."
}
},
"required": [
"PCID",
"org_id",
"usage_export_job_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The name of the workflow."
},
"all-branches": {
"type": "boolean",
"description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter."
},
"branch": {
"type": "string",
"description": "The name of a vcs branch. If not passed we will scope the API call to the default branch."
}
},
"required": [
"PCID",
"project-slug",
"workflow-name"
]
}
```
***
## 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`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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": {
"type": "string",
"description": "The fingerprint digest type to return. This may be either `md5` or `sha256`. If not passed, defaults to `md5`.",
"enum": [
"sha256",
"md5"
]
}
},
"required": [
"PCID",
"project-slug"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"owner-id": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The type of the owner. Defaults to \"organization\". Use \"account\" if you are using CircleCI server.",
"enum": [
"account",
"organization"
]
},
"page-token": {
"type": "string",
"description": "A token to specify which page of results to fetch."
}
},
"required": [
"PCID"
]
}
```
***
## 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). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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, 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)."
}
},
"required": [
"PCID",
"project-slug"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"context_id": {
"type": "string",
"description": "An opaque identifier of a context."
},
"page-token": {
"type": "string",
"description": "A token to specify which page of results to fetch."
}
},
"required": [
"PCID",
"context_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"provider": {
"type": "string",
"description": "The first segment of the slash-separated project slug, as shown in Project Settings > Overview.",
"enum": [
"github",
"gh",
"bitbucket",
"bb",
"circleci"
]
},
"organization": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "object",
"description": "The advanced value",
"properties": {
"autocancel_builds": {
"type": "boolean",
"description": "Except for the default branch, cancel running pipelines on a branch when a new pipeline starts on that branch."
},
"build_fork_prs": {
"type": "boolean",
"description": "Run builds for pull requests from forks."
},
"build_prs_only": {
"type": "boolean",
"description": "Once enabled, we will only build branches that have associated pull requests open."
},
"disable_ssh": {
"type": "boolean",
"description": "When set to true, job re-runs with SSH debugging access will be disabled for the project."
},
"forks_receive_secret_env_vars": {
"type": "boolean",
"description": "Run builds for forked pull requests with this project's configuration, environment variables, and secrets."
},
"oss": {
"type": "boolean",
"description": "Free and Open Source. Enabling this grants additional credits, and lets others see your builds, both through the web UI and the API."
},
"pr_only_branch_overrides": {
"type": "array",
"items": {
"type": "string"
},
"description": "This field is used in conjunction with the `build_prs_only`, it allows you to specify a list of branches that will always triger a build. The value passed will overwrite the existing value."
},
"set_github_status": {
"type": "boolean",
"description": "Report the status of every pushed commit to GitHub's status API. Updates reported per job."
},
"setup_workflows": {
"type": "boolean",
"description": "Enabling allows you to conditionally trigger configurations outside of the primary `.circleci` parent directory."
},
"write_settings_requires_admin": {
"type": "boolean",
"description": "Whether updating these settings requires a user to be an organization administrator. When disabled, updating settings can be done by any member."
}
}
}
},
"required": [
"PCID",
"provider",
"organization",
"project"
]
}
```