1. Packages
  2. Checkly
  3. Installation & Configuration
Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly

Checkly: Installation & Configuration

Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly

Installation

The Checkly provider is available as a package in most Pulumi languages:

Authentication

The Checkly provider must be configured with an API Key and an Account ID in order to deploy Checkly resources. Sign up for a Checkly account and follow our integration guide to create and configure your credentials.

Example configuration

First, configure your Checkly Account ID:

pulumi config set checkly:accountId YOUR_CHECKLY_ACCOUNT_ID

Then, configure you Checkly API key (with --secret):

pulumi config set checkly:apiKey YOUR_CHECKLY_API_KEY --secret

You should now be able to deploy Checkly resources.

Configuration options

The following configuration options are available for the Checkly provider:

  • checkly:accountId (environment: CHECKLY_ACCOUNT_ID) - your Checkly Account ID
  • checkly:apiKey (environment: CHECKLY_API_KEY) - your Checkly API Key
    • If you don’t have an API Key, you can create one here.
    • Make sure to use the --secret flag with pulumi config set.
  • checkly:apiUrl (environment: CHECKLY_API_URL) - for internal development purposes only
Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly