CircleCI
This Integration is part of the CircleCI Pack.#
Supported versions
Supported Cortex XSOAR versions: 5.5.0 and later.
Gets the details of the CircleCI workflows; including the details of the last runs and the jobs, and retrieves the artifacts of the jobs. This integration was integrated and tested with version v2 of CircleCI.
Configure CircleCI on Cortex XSOAR#
Navigate to Settings > Integrations > Servers & Services.
Search for CircleCI.
Click Add Instance to create and configure a new integration instance.
Parameter Description Required Your server URL True API key The API key used to connect True Version control system type Type of version control system True Organization Name Name of the organization True Project Name Name of the project True Trust any certificate (not secure) True Use system proxy settings False Click Test to validate the URLs, token, and connection.
Commands#
You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
circleci-workflows-list#
Gets information on workflows.
Base Command#
circleci-workflows-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| limit | Maximum number of workflows to retrieve. Default is 20. | Optional |
| vcs_type | Version control system type of the project. Possible values: "github" and bitbucket". Default is github. | Optional |
| organization | Organization from which to retrieve workflows. Defaults to the organization instance parameter. | Optional |
| project | Project from which to retrieve workflows. Defaults to the project instance parameter. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| CircleCI.Workflow.metrics.duration_metrics.max | Number | Maximum workflow run time. |
| CircleCI.Workflow.metrics.duration_metrics.mean | Number | Mean workflow run time. |
| CircleCI.Workflow.metrics.duration_metrics.median | Number | Median workflow run time. |
| CircleCI.Workflow.metrics.duration_metrics.min | Number | Minimum workflow run time. |
| CircleCI.Workflow.metrics.duration_metrics.p95 | Number | 95th percentile workflow run time. |
| CircleCI.Workflow.metrics.duration_metrics.standard_deviation | Number | The standard deviation of the workflow run time. |
| CircleCI.Workflow.metrics.duration_metrics.total_duration | Number | Total duration. |
| CircleCI.Workflow.metrics.failed_runs | Number | Number of failed workflow runs. |
| CircleCI.Workflow.metrics.median_credits_used | Number | Median credits used. |
| CircleCI.Workflow.metrics.mttr | Number | Mean recovery time. |
| CircleCI.Workflow.metrics.success_rate | Number | Success rate. |
| CircleCI.Workflow.metrics.successful_runs | Number | Number of successful runs. |
| CircleCI.Workflow.metrics.throughput | Number | Throughput. |
| CircleCI.Workflow.metrics.total_credits_used | Number | Total credits used. |
| CircleCI.Workflow.metrics.total_recoveries | Number | Total recoveries. |
| CircleCI.Workflow.metrics.total_runs | Number | Total runs. |
| CircleCI.Workflow.name | String | Workflow name. |
| CircleCI.Workflow.project_id | String | The project ID that the workflow belongs to. |
| CircleCI.Workflow.window_end | Date | When the workflow ended. |
| CircleCI.Workflow.window_start | Date | When the workflow started. |
Command Example#
!circleci-workflows-list limit=2
Context Example#
Human Readable Output#
CircleCI Workflows#
Metrics Name ProjectId WindowEnd WindowStart total_runs: 181
successful_runs: 136
mttr: 93519
total_credits_used: 323000
failed_runs: 43
median_credits_used: 0
success_rate: 0.7513812154696132
duration_metrics: {"min": 202, "mean": 8807, "median": 8606, "p95": 11307, "max": 16317, "standard_deviation": 1707.0, "total_duration": 0}
total_recoveries: 0
throughput: 2.033707865168539bucket_upload 4eaba5af-8c43-43ec-b469-3968d8a76f68 2021-06-28T23:42:38.647Z 2021-03-31T09:01:11.412Z total_runs: 2
successful_runs: 1
mttr: 0
total_credits_used: 1900
failed_runs: 1
median_credits_used: 0
success_rate: 0.5
duration_metrics: {"min": 3005, "mean": 4508, "median": 4508, "p95": 5860, "max": 6011, "standard_deviation": 2125.0, "total_duration": 0}
total_recoveries: 0
throughput: 0.2bucket_upload_trigger 4eaba5af-8c43-43ec-b469-3968d8a76f68 2021-04-22T14:28:57.252Z 2021-04-13T12:31:14.409Z
circleci-artifacts-list#
Retrieves the artifacts list from the CircleCI job.
Base Command#
circleci-artifacts-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| job_number | The number of the job from which to retrieve its artifacts, e.g., 31263. | Required |
| artifact_suffix | Returns only the artifacts for which the suffix corresponds to the given suffix, e.g., 'test_failures.txt' will only retrieve the artifacts for which the suffix ends with test_failures.txt. | Optional |
| limit | Maximum number of artifacts to retrieve. Default is 20. | Optional |
| vcs_type | The version control system type of the project. Possible values: "github" and "bitbucket". Default is github. | Optional |
| organization | Organization from which to retrieve artifacts. Defaults to the organization instance parameter. | Optional |
| project | Project from which to retrieve artifacts. Defaults to the project instance parameter. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| CircleCI.Artifact.path | String | Artifact relative path. |
| CircleCI.Artifact.node_index | Number | Artifact node index. |
| CircleCI.Artifact.url | String | Artifact URL. |
Command Example#
!circleci-artifacts-list job_number=390115 limit=2
Context Example#
Human Readable Output#
CircleCI Artifacts#
NodeIndex Path Url 0 artifacts/env.json https://390115-12353212-gh.circle-artifacts.com/0/artifacts/env.json 0 artifacts/debug_log.log https://390115-12353212-gh.circle-artifacts.com/0/artifacts/debug_log.log
circleci-workflow-jobs-list#
Retrieves the jobs list from the CircleCI workflow.
Base Command#
circleci-workflow-jobs-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| workflow_id | The workflow ID from which to retrieve its jobs, e.g., 12zxcase-12za-as51-123zs4sdgf12. | Required |
| limit | The maximum number of jobs to retrieve. Default is 20. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| CircleCI.WorkflowJob.id | String | Job ID. |
| CircleCI.WorkflowJob.job_number | Number | Job number. |
| CircleCI.WorkflowJob.name | String | Job name. |
| CircleCI.WorkflowJob.project_slug | String | Job project slug. |
| CircleCI.WorkflowJob.started_at | Date | Time the job started. |
| CircleCI.WorkflowJob.status | String | Job status. |
| CircleCI.WorkflowJob.stopped_at | Date | Time the job stopped. |
| CircleCI.WorkflowJob.type | String | Job type. |
| CircleCI.WorkflowJob.dependencies | String | Job dependencies. |
Command Example#
!circleci-workflow-jobs-list workflow_id=f85efae0-cbf4-4b6d-b136-e3db67d41221 limit=2
Context Example#
Human Readable Output#
CircleCI Workflow f85efae0-cbf4-4b6d-b136-e3db67d41221 Jobs#
Dependencies Id JobNumber Name ProjectSlug StartedAt Status StoppedAt Type c7425325-bb57-4e78-968f-2c9867d31z11 389133 Setup Environment gh/organization_name/repo_name 2021-06-24T00:04:57Z success 2021-06-24T00:06:32Z build c7425325-bb57-4e78-968f-2c9867d31z11 89d36e04-5481-48a3-8be4-ddcb2bdcz1q1 389166 Run Validations gh/organization_name/repo_name 2021-06-24T00:06:35Z success 2021-06-24T00:38:00Z build
circleci-workflow-last-runs#
Retrieves the jobs list from the CircleCI workflow.
Base Command#
circleci-workflow-last-runs
Input#
| Argument Name | Description | Required |
|---|---|---|
| workflow_name | Name of the workflow from which to retrieve its last runs details. | Required |
| limit | Maximum number of workflow runs to retrieve. Default is 20. | Optional |
| vcs_type | Version control system type of the project. Possible values: "github" and "bitbucket". Default is github. | Optional |
| organization | Organization from which to retrieve workflow last runs. Defaults to the organization instance parameter. | Optional |
| project | Project from which to retrieve workflow last runs. Defaults to the project instance parameter. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| CircleCI.WorkflowRun.branch | String | Branch name. |
| CircleCI.WorkflowRun.created_at | Date | Time run created. |
| CircleCI.WorkflowRun.credits_used | Number | Credits used. |
| CircleCI.WorkflowRun.duration | Number | Duration of run in seconds. |
| CircleCI.WorkflowRun.id | String | ID of the run. |
| CircleCI.WorkflowRun.status | String | Run status. |
| CircleCI.WorkflowRun.stopped_at | Date | Time run stopped. |
Command Example#
!circleci-workflow-last-runs workflow_name=nightly limit=2
Context Example#
Human Readable Output#
CircleCI Workflow nightly Last Runs#
Branch CreatedAt CreditsUsed Duration Id Status StoppedAt master 2021-06-29T00:04:56.069Z 2482 7743 d832d004-0069-4412-8e6d-41265143411z failed 2021-06-29T02:13:59.354Z master 2021-06-28T00:04:55.409Z 3129 9778 531e678e-73e3-4f2a-ac80-55aa203461za failed 2021-06-28T02:47:52.916Z
circleci-trigger-workflow#
Triggers a new pipeline on the project.
Base Command#
circleci-trigger-workflow
Input#
| Argument Name | Description | Required |
|---|---|---|
| parameters | A JSON object containing pipeline parameters and their values. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| CircleCI.WorkflowTrigger.id | number | The workflow ID. |
| CircleCI.WorkflowTrigger.created_at | number | Date when the workflow was created. |
| CircleCI.WorkflowTrigger.number | number | The workflow number. |
| CircleCI.WorkflowTrigger.state | number | The workflow state. |
Command Example#
!circleci-trigger-workflow parameters={"param1": "value"}
Context Example#
Human Readable Output#
CircleCI Workflow created successfully, ID=103232