POST
/
v1
/
snippets
Create a snippet
curl --request POST \
  --url https://api.checklyhq.com/v1/snippets \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Snippet",
  "script": "request.url = request.url + '\''/extra'\''"
}'
{
  "id": 1,
  "name": "Snippet",
  "script": "request.url = request.url + '/extra'",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

​
Overview

The Create Snippet endpoint allows you to create new reusable code snippets that can be shared across multiple checks. Snippets help maintain code consistency and reduce duplication in your monitoring setup. Common Use Cases:
  • Shared Function Creation
  • Code Template Development
  • Authentication Logic Reuse
  • Utility Function Storage
Create snippets for commonly used functions, authentication patterns, and utility code to maintain consistency across your monitoring checks.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here.

Your API key is like a password: keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Body

application/json
​
name
string
required

The snippet name.

Example:

"Snippet"

​
script
string
required

Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.

Example:

"request.url = request.url + '/extra'"

Response

Created

​
id
number
Example:

1

​
name
string

The snippet name.

Example:

"Snippet"

​
script
string

Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.

Example:

"request.url = request.url + '/extra'"

​
created_at
string<date-time>
​
updated_at
string<date-time>