index.md

page_title	description
Provider: CircleCI	The CircleCI provider enpowers users to CircleCI resources via Terraform

CIRCLECI Provider

This is an unofficial Terraform provider for CircleCI.

The CircleCI provider supports the creation of specific CircleCI resources.

Currently, the following resources are supported:

• Project
• Project Webhook
• Project Scheduled Pipeline
• Project Environment Variables
• Project Checkout key
• Context
• Context Environment Variables
• Runner Resource-class
• Runner Token

Use the navigation to the left to read about the available resources.

Example Usage

terraform {
  required_providers {
    circleci = {
      source = "kelvintaywl/circleci"
      # update version accordingly
      version = "0.12.0"
    }
  }
}

provider "circleci" {
  // You can also set this via CIRCLE_TOKEN environment variable.
  api_token = "myCircleCIUserAPIToken"

  // Defaults to circleci.com
  // If you are using a self-hosted CircleCI instance (aka Server),
  // specify your self-hosted server's domain here ('https://' not required).
  // This can also be set via CIRCLE_HOSTNAME environment variable,
  hostname = "circleci.com"
}

Schema

Optional

• api_token (String) A CircleCI user API token. This can also be set via the CIRCLE_TOKEN environment variable.
• hostname (String) CircleCI hostname (default: circleci.com). This can also be set via the CIRCLE_HOSTNAME environment variable.