Skip to content

Scripts

thc202 edited this page Aug 4, 2023 · 5 revisions

Zest Scripts are top level containers for all of the other elements.

Attributes

Name Format Description
about String A standard string that should be the same for all Zest scripts (see below)
zestVersion String The version of Zest this script conforms to, currently only "1" is supported
generatedBy String The tools used to generate the script
title String A summary of what the script is intended to do
description String A longer description which can give more details about the script
prefix String If specified this must be a URL prefix that is common to all of the requests
tokens Object Details of the Tokens used in the script
statements Array The Statements included in the script
authentication Array The Authentication used by the script
index Integer Always 0
elementType String Always ZestScript

JSON

An example blank script:
{
  "about": "This is a Zest script. For more details about Zest visit https://developer.mozilla.org/en-US/docs/Zest",
  "zestVersion": 1,
  "generatedBy": "ZAP Dev Build",
  "title": "An empty script",
  "description": "An example empty script",
  "prefix": "",
  "tokens": {
    "tokenStart": "{{",
    "tokenEnd": "}}",
    "tokens": {},
    "elementType": "ZestTokens"
  },
  "statements": [],
  "authentication": [],
  "index": 0,
  "elementType": "ZestScript"
}

See also