category: Utilities
provider: CircleCI
commonfields:
  id: CircleCI
  version: -1
configuration:
- defaultvalue: https://circleci.com
  display: Your server URL
  name: url
  required: true
  type: 0
- display: The API key
  additionalinfo: The API Key to use for connection. Required for private repositories.
  name: api_key
  type: 4
  hidden: true
  required: false
- name: api_key_creds
  type: 9
  displaypassword: The API key
  hiddenusername: true
  required: false
- display: Version control system type
  name: vcs_type
  type: 15
  required: true
  additionalinfo: Type of version control system
  options:
  - github
  - bitbucket
- display: Organization name
  name: organization
  type: 0
  required: true
  additionalinfo: Name of the organization
- display: Project Name
  name: project
  required: true
  type: 0
  additionalinfo: Name of the project
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
- display: Use system proxy settings
  name: proxy
  type: 8

  required: false
description: Gets the details of the CircleCI workflows; including the details of the last runs and the jobs, and retrieves the artifacts of the jobs.
display: CircleCI
name: CircleCI
script:
  commands:
  - arguments:
    - description: The maximum number of workflows to retrieve.
      defaultValue: '20'
      name: limit
    - name: vcs_type
      description: 'The version control system type of the project. Possible values: "github" and "bitbucket".'
      default: true
      auto: PREDEFINED
      predefined:
      - github
      - bitbucket
      defaultValue: github
    - description: The organization from which to retrieve workflows. Defaults to the organization instance parameter.
      name: organization
    - description: The project from which to retrieve workflows. Defaults to the project instance parameter.
      name: project
    description: Gets information on workflows.
    name: circleci-workflows-list
    outputs:
    - contextPath: CircleCI.Workflow.metrics.duration_metrics.max
      description: Maximum workflow run time.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.duration_metrics.mean
      description: Mean workflow run time.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.duration_metrics.median
      description: Median workflow run time.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.duration_metrics.min
      description: Minimum workflow run time.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.duration_metrics.p95
      description: The 95th percentile workflow run time.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.duration_metrics.standard_deviation
      description: The standard deviation of the workflow run time.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.duration_metrics.total_duration
      description: Total duration.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.failed_runs
      description: Number of failed workflow runs.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.median_credits_used
      description: Median credits used.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.mttr
      description: Mean recovery time.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.success_rate
      description: Success rate.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.successful_runs
      description: Number of successful runs.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.throughput
      description: Throughput.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.total_credits_used
      description: Total credits used.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.total_recoveries
      description: Total recoveries.
      type: Number
    - contextPath: CircleCI.Workflow.metrics.total_runs
      description: Total runs.
      type: Number
    - contextPath: CircleCI.Workflow.name
      description: Workflow name.
      type: String
    - contextPath: CircleCI.Workflow.project_id
      description: The project ID that the workflow belongs to.
      type: String
    - contextPath: CircleCI.Workflow.window_end
      description: When the workflow ended.
      type: Date
    - contextPath: CircleCI.Workflow.window_start
      description: When the workflow started.
      type: Date
  - arguments:
    - description: The number of the job used to retrieve its artifacts, e.g., 31263.
      name: job_number
      required: true
    - description: Returns only the artifacts for which the suffix corresponds to the given suffix, e.g., 'test_failures.txt' will only retrieve artifacts for which the suffix ends with test_failures.txt.
      name: artifact_suffix
    - description: The maximum number of artifacts to retrieve.
      defaultValue: '20'
      name: limit
    - name: vcs_type
      description: 'The version control system type of the project. Possible values: "github" and "bitbucket".'
      default: true
      auto: PREDEFINED
      predefined:
      - github
      - bitbucket
      defaultValue: github
    - description: The organization from which to retrieve artifacts. Defaults to the organization instance parameter.
      name: organization
    - description: The project from which to retrieve artifacts. Defaults to the project instance parameter.
      name: project
    description: Retrieves the artifacts list from the CircleCI job.
    name: circleci-artifacts-list
    outputs:
    - contextPath: CircleCI.Artifact.path
      description: Artifact relative path.
      type: String
    - contextPath: CircleCI.Artifact.node_index
      description: Artifact node index.
      type: Number
    - contextPath: CircleCI.Artifact.url
      description: Artifact URL.
      type: String
  - arguments:
    - description: The workflow ID from which to retrieve its jobs, e.g., 12zxcase-12za-as51-123zs4sdgf12.
      name: workflow_id
      required: true
    - description: The maximum number of jobs to retrieve.
      defaultValue: '20'
      name: limit
    description: Retrieves the jobs list from the CircleCI workflow.
    name: circleci-workflow-jobs-list
    outputs:
    - contextPath: CircleCI.WorkflowJob.id
      description: Job ID.
      type: String
    - contextPath: CircleCI.WorkflowJob.job_number
      description: Job number.
      type: Number
    - contextPath: CircleCI.WorkflowJob.name
      description: Job name.
      type: String
    - contextPath: CircleCI.WorkflowJob.project_slug
      description: Job project slug.
      type: String
    - contextPath: CircleCI.WorkflowJob.started_at
      description: Time the job started.
      type: Date
    - contextPath: CircleCI.WorkflowJob.status
      description: Job status.
      type: String
    - contextPath: CircleCI.WorkflowJob.stopped_at
      description: Time the job stopped.
      type: Date
    - contextPath: CircleCI.WorkflowJob.type
      description: Job type.
      type: String
    - contextPath: CircleCI.WorkflowJob.dependencies
      description: Job dependencies.
      type: String
  - arguments:
    - description: Name of the workflow from which to retrieve its last runs details.
      name: workflow_name
      required: true
    - description: The maximum number of workflow runs to retrieve.
      defaultValue: '20'
      name: limit
    - name: vcs_type
      description: 'The version control system type of the project. Possible values: "github" and "bitbucket".'
      default: true
      auto: PREDEFINED
      predefined:
      - github
      - bitbucket
      defaultValue: github
    - description: Organization from which to retrieve workflow last runs. Defaults to the organization instance parameter.
      name: organization
    - description: Project from which to retrieve workflow last runs. Defaults to the project instance parameter.
      name: project
    - description: Name of the branch.
      name: branch
    description: Retrieves the jobs list from the CircleCI workflow.
    name: circleci-workflow-last-runs
    outputs:
    - contextPath: CircleCI.WorkflowRun.branch
      description: Branch name.
      type: String
    - contextPath: CircleCI.WorkflowRun.created_at
      description: Time the run was created.
      type: Date
    - contextPath: CircleCI.WorkflowRun.credits_used
      description: Credits used.
      type: Number
    - contextPath: CircleCI.WorkflowRun.duration
      description: Duration of the run in seconds.
      type: Number
    - contextPath: CircleCI.WorkflowRun.id
      description: ID of the run.
      type: String
    - contextPath: CircleCI.WorkflowRun.status
      description: Run status.
      type: String
    - contextPath: CircleCI.WorkflowRun.stopped_at
      description: Time the run stopped.
      type: Date
  - arguments:
    - description: A JSON object containing pipeline parameters and their values.
      name: parameters
      required: true
    description: Triggers a new pipeline on the project.
    name: circleci-trigger-workflow
    outputs:
    - contextPath: CircleCI.WorkflowTrigger.id
      description: The workflow ID.
      type: number
    - contextPath: CircleCI.WorkflowTrigger.created_at
      description: Date when the workflow was created.
      type: number
    - contextPath: CircleCI.WorkflowTrigger.number
      description: The workflow number.
      type: number
    - contextPath: CircleCI.WorkflowTrigger.state
      description: The workflow state.
      type: number
  runonce: false
  script: '-'
  type: python
  subtype: python3
  dockerimage: demisto/python3:3.12.13.10116658
fromversion: 5.5.0
tests:
- No tests (auto formatted)