# 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/).
Raw data
{
"_id": null,
"home_page": null,
"name": "pulumi-checkly",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "pulumi, checkly, category/monitoring",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9f/c8/3f272ffed080d5fc7fb1983f4ba0c5ee9e358f7eddbbf6d2a23e8257f8f4/pulumi_checkly-2.0.0.tar.gz",
"platform": null,
"description": "# Checkly Provider for Pulumi\n\n\n\n\nThe Checkly provider for Pulumi can be used to provision any of the monitoring resources available in [Checkly](https://www.checklyhq.com/).\n\n## Installation\n\nThe Checkly provider is available as a package in most Pulumi languages:\n\n* JavaScript/TypeScript: [`@checkly/pulumi`](https://www.npmjs.com/package/@checkly/pulumi)\n* Python: [`pulumi-checkly`](https://pypi.org/project/pulumi-checkly/)\n* Go: [`github.com/checkly/pulumi-checkly/sdk/v2/go/checkly`](https://github.com/checkly/pulumi-checkly)\n* .NET: [`Pulumi.Checkly`](https://www.nuget.org/packages/Pulumi.Checkly)\n\n\n## Authentication\n\nThe 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.\n\n### Example configuration\n\nFirst, configure your Checkly Account ID:\n\n```\npulumi config set checkly:accountId YOUR_CHECKLY_ACCOUNT_ID\n```\n\nThen, configure you Checkly API key (with `--secret`):\n\n```\npulumi config set checkly:apiKey YOUR_CHECKLY_API_KEY --secret\n```\n\nYou should now be able to deploy Checkly resources.\n\n## Example usage\n\nYou can find working JavaScript and TypeScript code samples in the [`./examples`](https://github.com/checkly/pulumi-checkly/tree/main/examples) directory.\n\n## Configuration options\n\nThe following configuration points are available for the Checkly provider:\n\n- `checkly:accountId` (environment: `CHECKLY_ACCOUNT_ID`) - your Checkly Account ID\n- `checkly:apiKey` (environment: `CHECKLY_API_KEY`) - your Checkly API Key\n * If you don't have an API Key, you can create one [here](https://app.checklyhq.com/settings/user/api-keys).\n * Make sure to use the `--secret` flag with `pulumi config set`.\n- `checkly:apiUrl` (environment: `CHECKLY_API_URL`) - for internal development purposes only\n\n## Reference\n\nFor detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/checkly/api-docs/).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing Checkly monitoring resources.",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://www.pulumi.com/registry/packages/checkly",
"Repository": "https://github.com/checkly/pulumi-checkly"
},
"split_keywords": [
"pulumi",
" checkly",
" category/monitoring"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b8c9d30e6e0855e8fb387664a10fe054861ab3387b643d1229fb15aa9d5821a7",
"md5": "599bb154a7ee078fe971ac02f63bddc8",
"sha256": "a485d154e8c3ab1c38240a254ce169f918711ba1ecfb54d9e12a626b5c54e297"
},
"downloads": -1,
"filename": "pulumi_checkly-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "599bb154a7ee078fe971ac02f63bddc8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 71267,
"upload_time": "2025-02-04T16:32:30",
"upload_time_iso_8601": "2025-02-04T16:32:30.392855Z",
"url": "https://files.pythonhosted.org/packages/b8/c9/d30e6e0855e8fb387664a10fe054861ab3387b643d1229fb15aa9d5821a7/pulumi_checkly-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9fc83f272ffed080d5fc7fb1983f4ba0c5ee9e358f7eddbbf6d2a23e8257f8f4",
"md5": "1cd2601551c207294e8d1426cd80de93",
"sha256": "55d6ae2dd85361335f6a08eaa70a7e83e72f9830c21634c1a374657d12c448e8"
},
"downloads": -1,
"filename": "pulumi_checkly-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1cd2601551c207294e8d1426cd80de93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 57100,
"upload_time": "2025-02-04T16:32:31",
"upload_time_iso_8601": "2025-02-04T16:32:31.444452Z",
"url": "https://files.pythonhosted.org/packages/9f/c8/3f272ffed080d5fc7fb1983f4ba0c5ee9e358f7eddbbf6d2a23e8257f8f4/pulumi_checkly-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-04 16:32:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "checkly",
"github_project": "pulumi-checkly",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-checkly"
}
JSON
