GET
/
v1
/
snippets
/
{id}
Retrieve a snippet
curl --request GET \
  --url https://api.checklyhq.com/v1/snippets/{id} \
  --header 'Authorization: <api-key>'
{
  "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 Get Snippet endpoint retrieves detailed information about a specific code snippet, including its source code, description, and usage metadata. Common Use Cases:
  • Snippet Content Retrieval
  • Code Review
  • Template Usage
  • Snippet Management
Use this endpoint to retrieve snippet source code for integration into checks or for code review purposes.

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

Path Parameters

​
id
integer
required

Response

Successful

​
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>