CHchecklyhq
Snippets

Create a snippet

Changed on

Creates a new snippet.

post/v1/snippets

Request

Headers

x-checkly-accountstring

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

Request body

namestring required

The snippet name.

scriptstring required

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

Example request

{
  "name": "Snippet",
  "script": "request.url = request.url + '/extra'"
}

Response

Created

idnumber
namestring

The snippet name.

scriptstring

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

created_atstring date-time
updated_atstring date-time nullable

Example response

{
  "id": 1,
  "name": "Snippet",
  "script": "request.url = request.url + '/extra'"
}

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 87d29dc7b4feRevision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • info

      added the non-success response with the status