https://github.com/checkly/pulumi-checkly
Pulumi provider for the Checkly monitoring service
https://github.com/checkly/pulumi-checkly
checkly mac pulumi pulumi-provider
Last synced: 2 months ago
JSON representation
Pulumi provider for the Checkly monitoring service
- Host: GitHub
- URL: https://github.com/checkly/pulumi-checkly
- Owner: checkly
- License: apache-2.0
- Created: 2022-02-16T00:47:27.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-19T10:42:55.000Z (3 months ago)
- Last Synced: 2026-04-01T08:44:03.139Z (3 months ago)
- Topics: checkly, mac, pulumi, pulumi-provider
- Language: Makefile
- Homepage:
- Size: 2.06 MB
- Stars: 19
- Watchers: 10
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Copyright: COPYRIGHT
Awesome Lists containing this project
README
# Checkly Provider for Pulumi
The Checkly provider for Pulumi can be used to provision any of the monitoring resources available in [Checkly](https://www.checklyhq.com/).
## Installation
The Checkly provider is available as a package in most Pulumi languages:
* JavaScript/TypeScript: [`@checkly/pulumi`](https://www.npmjs.com/package/@checkly/pulumi)
* Python: [`pulumi-checkly`](https://pypi.org/project/pulumi-checkly/)
* Go: [`github.com/checkly/pulumi-checkly/sdk/v2/go/checkly`](https://github.com/checkly/pulumi-checkly)
* .NET: [`Pulumi.Checkly`](https://www.nuget.org/packages/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](https://www.checklyhq.com) account and follow our [integration guide](https://www.checklyhq.com/docs/integrations/pulumi/) 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.
## Example usage
You can find working JavaScript and TypeScript code samples in the [`./examples`](https://github.com/checkly/pulumi-checkly/tree/main/examples) directory.
## Configuration options
The following configuration points 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](https://app.checklyhq.com/settings/user/api-keys).
* Make sure to use the `--secret` flag with `pulumi config set`.
- `checkly:apiUrl` (environment: `CHECKLY_API_URL`) - for internal development purposes only
## Reference
For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/checkly/api-docs/).