Viewing docs for Checkly v2.11.0
published on Tuesday, Apr 21, 2026 by Checkly
published on Tuesday, Apr 21, 2026 by Checkly
Checkly: Installation & Configuration
I want to use the Pulumi Checkly package (checkly) in my project.
## Provider details
- Package: checkly
- Version: v2.11.0
- Publisher: Checkly
- Source: pulumi
- Repository: https://github.com/checkly/pulumi-checkly
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/checkly/checkly/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/checkly/checkly/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/checkly/checkly/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/checkly/checkly/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for Checkly v2.11.0
published on Tuesday, Apr 21, 2026 by Checkly
published on Tuesday, Apr 21, 2026 by Checkly
Installation
The Checkly provider is available as a package in most Pulumi languages:
- JavaScript/TypeScript:
@checkly/pulumi - Python:
pulumi-checkly - Go:
github.com/checkly/pulumi-checkly/sdk/v2/go/checkly - .NET:
Pulumi.Checkly
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 IDcheckly: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
--secretflag withpulumi config set.
checkly:apiUrl(environment:CHECKLY_API_URL) - for internal development purposes only
Viewing docs for Checkly v2.11.0
published on Tuesday, Apr 21, 2026 by Checkly
published on Tuesday, Apr 21, 2026 by Checkly