Skip to content

Commit

Permalink
Add more details to terraform provider
Browse files Browse the repository at this point in the history
  • Loading branch information
justindeguzman authored Jun 23, 2023
1 parent 95cbd0b commit 3c1ae72
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions docs/en/cloud/manage/api/api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,18 @@ The ClickHouse Cloud API is a REST API designed for developers to easily manage

Developers are limited to 100 API keys per organization. Each API key has a limit of 10 requests over a 10-second window. If you'd like to increase the number of API keys or requests per 10-second window for your organization, please contact [email protected]


## Terraform Provider

The ClickHouse Terraform provider is available:
- [README](https://github.com/ClickHouse/terraform-provider-clickhouse/blob/main/README.md)
- [Terraform registry](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs)
The official ClickHouse Terraform Provider lets you use [Infrastructure as Code](https://www.redhat.com/en/topics/automation/what-is-infrastructure-as-code-iac) to create predictable, version-controlled configurations to make deployments much less error-prone.

You can view the Terraform provider docs in the [Terraform registry](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs).

If you'd like to contribute to the ClickHouse Terraform Provider, you can view the source [in the GitHub repo](https://github.com/ClickHouse/terraform-provider-clickhouse).

## Swagger Endpoint and UI
## Swagger (OpenAPI) Endpoint and UI

The ClickHouse Cloud API is built on the open-source [OpenAPI specification](https://www.openapis.org/) to allow for predictable client-side consumption. If you need to programmatically consume the ClickHouse Cloud API docs, we offer a JSON-based Swagger endpoint via https://api.clickhouse.cloud/v1. Our API Reference docs are automatically generated from that same endpoint. If you prefer to consume the API docs via the Swagger UI, please click [here](https://clickhouse.com/docs/en/cloud/manage/api/swagger).

## Support

We recommend visiting [our Slack channel](https://clickhouse.com/slack) first to get quick support. If you'd like additional help or more info about our API and its capabilities, please contact ClickHouse Support at https://clickhouse.cloud/support

## Endpoints

The [endpoint docs are here](/docs/en/cloud/manage/api/invitations-api-reference.md). Use your API Key and API Secret with the base URL `https://api.clickhouse.cloud/v1`.

0 comments on commit 3c1ae72

Please sign in to comment.