{"id":15372719,"url":"https://github.com/bitfield/terraform-provider-checkly","last_synced_at":"2025-07-25T15:10:52.591Z","repository":{"id":57493370,"uuid":"193697702","full_name":"bitfield/terraform-provider-checkly","owner":"bitfield","description":"A Terraform provider for the Checkly monitoring service","archived":false,"fork":false,"pushed_at":"2022-12-22T17:12:47.000Z","size":138,"stargazers_count":15,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-15T14:42:06.675Z","etag":null,"topics":["checkly","terraform-provider"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitfield.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"bitfield"}},"created_at":"2019-06-25T11:49:18.000Z","updated_at":"2022-12-22T17:11:51.000Z","dependencies_parsed_at":"2023-01-30T14:45:18.422Z","dependency_job_id":null,"html_url":"https://github.com/bitfield/terraform-provider-checkly","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/bitfield/terraform-provider-checkly","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfield%2Fterraform-provider-checkly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfield%2Fterraform-provider-checkly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfield%2Fterraform-provider-checkly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfield%2Fterraform-provider-checkly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitfield","download_url":"https://codeload.github.com/bitfield/terraform-provider-checkly/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfield%2Fterraform-provider-checkly/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267023222,"owners_count":24022915,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checkly","terraform-provider"],"created_at":"2024-10-01T13:52:55.718Z","updated_at":"2025-07-25T15:10:52.572Z","avatar_url":"https://github.com/bitfield.png","language":"Go","funding_links":["https://github.com/sponsors/bitfield"],"categories":[],"sub_categories":[],"readme":"# Checkly Terraform provider\n\n[![CircleCI](https://circleci.com/gh/bitfield/terraform-provider-checkly/tree/master.svg?style=svg)](https://circleci.com/gh/bitfield/terraform-provider-checkly/tree/master)\n\nThis Terraform provider enables users to manage [Checkly](https://checklyhq.com) resources like checks.\n\nYou can read a detailed tutorial and explanation of the Checkly Terraform provider here:\n\n* [Managing Checkly checks with Terraform](https://blog.checklyhq.com/managing-checkly-checks-with-terraform/)\n\n## Using the provider\n\n1. Download the binary applicable for your platform from the [latest tagged release](https://github.com/bitfield/terraform-provider-checkly/releases).\nThen copy the binary to your Terraform plugin folder, unzip it and rename it to just `terraform-provider-checkly`. Lastly, set the correct access rights.\n\n\nI you're on MacOS, just run the script `install.sh` script\n\n```bash\ncurl https://raw.githubusercontent.com/bitfield/terraform-provider-checkly/master/install.sh | sh\n```\n\n\n2. Run `terraform init` and then `terraform providers`. The Checkly plugin should be listed.\n\n```bash\nterraform init\n\nInitializing provider plugins...\nTerraform has been successfully initialized!\n\nterraform providers\n.\n└── provider.checkly\n```\n\nIf you're having issues, please check [the Hashicorp docs on installing third party plugins.](https://www.terraform.io/docs/configuration/providers.html#third-party-plugins)\n\n### Authentication\n\nTo use the provider with your Checkly account, you will need an API Key for the account. Go to the [Account Settings: API Keys page](https://app.checklyhq.com/account/api-keys) and click 'Create API Key'.\n\nNow expose the API key as an environment variable in your shell:\n\n```bash\nexport TF_VAR_checkly_api_key=\u003cmy_api_key\u003e\n```\n\n### Usage examples\n\nAdd a `checkly_check` resource to your resource file.\n\nThis first example is a very minimal API check.\n\n```terraform\nvariable \"checkly_api_key\" {}\n\nprovider \"checkly\" {\n  api_key = \"${var.checkly_api_key}\"\n}\n\nresource \"checkly_check\" \"example-check\" {\n  name                      = \"Example check\"\n  type                      = \"API\"\n  activated                 = true\n  should_fail               = false\n  frequency                 = 1\n  double_check              = true\n  ssl_check                 = true\n  ssl_check_domain          = \"api.example.com\"\n  use_global_alert_settings = true\n\n  locations = [\n    \"us-west-1\"\n  ]\n\n  request {\n    url              = \"https://api.example.com/\"\n    follow_redirects = true\n    assertion {\n      source     = \"STATUS_CODE\"\n      comparison = \"EQUALS\"\n      target     = \"200\"\n    }\n  }\n}\n```\n\nHere's something a little more complicated, to show what you can do:\n\n```terraform\nresource \"checkly_check\" \"example-check2\" {\n  name                   = \"Example check 2\"\n  type                   = \"API\"\n  activated              = true\n  should_fail            = true\n  frequency              = 1\n  ssl_check_domain       = \"api.example.com\"\n  double_check           = true\n  degraded_response_time = 5000\n  max_response_time      = 10000\n\n  locations = [\n    \"us-west-1\",\n    \"ap-northeast-1\",\n    \"ap-south-1\",\n  ]\n\n  alert_settings {\n    escalation_type = \"RUN_BASED\"\n\n    run_based_escalation {\n      failed_run_threshold = 1\n    }\n\n    time_based_escalation {\n      minutes_failing_threshold = 5\n    }\n\n    ssl_certificates {\n      enabled         = true\n      alert_threshold = 30\n    }\n\n    reminders {\n      amount = 1\n    }\n  }\n\n  request {\n    follow_redirects = true\n    url              = \"http://api.example.com/\"\n\n    query_parameters = {\n      search = \"foo\"\n    }\n\n    headers = {\n      X-Bogus = \"bogus\"\n    }\n\n    assertion {\n      source     = \"JSON_BODY\"\n      property   = \"code\"\n      comparison = \"HAS_VALUE\"\n      target     = \"authentication.failed\"\n    }\n\n    assertion {\n      source     = \"STATUS_CODE\"\n      property   = \"\"\n      comparison = \"EQUALS\"\n      target     = \"401\"\n    }\n\n    basic_auth {\n      username = \"\"\n      password = \"\"\n    }\n  }\n}\n```\n\n## Developing the provider\n\nClone the repo, build the project and add it to your Terraform plugins directory. You will need to have Go installed.\n\n```bash\ngit clone git@github.com:bitfield/terraform-provider-checkly.git\ncd terraform-provider-checkly\ngo test\ngo build \u0026\u0026 CHECKLY_API_KEY=XXX go test -tags=integration\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfield%2Fterraform-provider-checkly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitfield%2Fterraform-provider-checkly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfield%2Fterraform-provider-checkly/lists"}