Back to Infisical

Checkly Connection

docs/integrations/app-connections/checkly.mdx

0.159.253.8 KB
Original Source

Infisical supports the use of API Keys to connect with Checkly. <Note> Checkly requires the account user to have Read/Write or Admin permissions </Note>

Create a Checkly API Token

<Steps> <Step title="Click the profile image in the top-right corner and select 'User Settings'"> ![Dashboard Page](/images/app-connections/checkly/checkly-app-connection-profile.png) </Step> <Step title="In the user settings sidebar, select 'API Keys'"> ![User Settings Page](/images/app-connections/checkly/checkly-app-connection-api-keys.png) </Step> <Step title="In the api keys page, click on 'Create API Key'"> ![Api Keys Page](/images/app-connections/checkly/checkly-app-connection-create-api-key.png) </Step> <Step title="Enter a token name and click on 'Create API Key'"> Provide a descriptive name for the token.
![Enter Name](/images/app-connections/checkly/checkly-app-connection-create-form.png)
</Step> <Step title="Copy the generated key and save it"> ![Create Token](/images/app-connections/checkly/checkly-app-connection-key-generated.png) </Step> </Steps>

Create a Checkly Connection in Infisical

<Tabs> <Tab title="Infisical UI"> <Steps> <Step title="Navigate to App Connections"> In your Infisical dashboard, navigate to the **Integrations** tab in the desired project, then select **App Connections**.
    ![App Connections Tab](/images/app-connections/general/add-connection.png)
  </Step>
  <Step title="Select Checkly Connection">
    Click **+ Add Connection** and choose **Checkly Connection** from the list of integrations.

    ![Select Checkly Connection](/images/app-connections/checkly/checkly-app-connection-option.png)
  </Step>
  <Step title="Fill out the Checkly Connection form">
    Complete the form by providing:
    - A descriptive name for the connection
    - An optional description
    - The API Key value from the previous step

    ![Checkly Connection Modal](/images/app-connections/checkly/checkly-app-connection-form.png)
  </Step>
  <Step title="Connection created">
    After submitting the form, your **Checkly Connection** will be successfully created and ready to use with your Infisical project.

    ![Checkly Connection Created](/images/app-connections/checkly/checkly-app-connection-generated.png)
  </Step>
</Steps>
</Tab> <Tab title="API"> To create a Checkly Connection via API, send a request to the [Create Checkly Connection](/api-reference/endpoints/app-connections/checkly/create) endpoint.
### Sample request

```bash Request
curl    --request POST \
        --url https://app.infisical.com/api/v1/app-connections/checkly \
        --header 'Content-Type: application/json' \
        --data '{
            "name": "my-checkly-connection",
            "method": "api-key",
            "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
            "credentials": {
                "apiKey": "[API KEY]"
            }
        }'
```

### Sample response

```bash Response
{
  "appConnection": {
      "id": "e5d18aca-86f7-4026-a95e-efb8aeb0d8e6",
      "name": "my-checkly-connection",
      "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
      "description": null,
      "version": 1,
      "orgId": "6f03caa1-a5de-43ce-b127-95a145d3464c",
      "createdAt": "2025-04-23T19:46:34.831Z",
      "updatedAt": "2025-04-23T19:46:34.831Z",
      "isPlatformManagedCredentials": false,
      "credentialsHash": "7c2d371dec195f82a6a0d5b41c970a229cfcaf88e894a5b6395e2dbd0280661f",
      "app": "checkly",
      "method": "api-key",
      "credentials": {}
  }
}
```
</Tab> </Tabs>