Scripting API

Methods for creating and managing test scripts for use in load testing and monitoring.

Method summary

endpoint()

  Navigate to a single url with a basic RBU script

validate()

  Trigger script validation

list()

  List all scripts associated with the account

list_valid()

  List all valid scripts

list_invalid()

  List all invalid scripts

upload()

  Upload a test script

clone()

  Clone an existing script

delete()

  Delete a script

retrieve()

  Retrieve a script's information

update()

  Update an existing script

endpoint

endpoint(string url)

Navigate to a single url with a basic RBU script

Arguments:

  url - The url to monitor

Example:

c.script().endpoint('https://www.example.com/')

validate

validate()

Trigger script validation

Example:

c.script().validate('script_id')

list

list()

List all scripts associated with the account

Example:

c.script().list()

list_valid

list_valid()

List all valid scripts

Example:

c.script().list_valid()

list_invalid

list_invalid()

List all invalid scripts

Example:

c.script().list_invalid()

upload

upload(string name, string body)

Upload a test script

Arguments:

  name - Name of the script

  body - Contents of the test script

Example:

c.script().upload('Check example.com', 'var driver = openBrowser(); beginTransaction(function(tx) { beginStep(function(step) { driver.get("http://www.example.com/"); }); });')

clone

clone()

Clone an existing script

Example:

c.script('script_id').clone()

delete

delete()

Delete a script

Example:

c.script('script_id').delete()

retrieve

retrieve()

Retrieve a script's information

Example:

c.script().retrieve()

update

update()

Update an existing script

Arguments:

  name - Name of the script

  body - Contents of the test script

  validation_bypassed - Whether to bypass script validation (False by default)

Example:

c.script('script_id').update('Check example.com', 'var driver = openBrowser(); beginTransaction(function(tx) { beginStep(function(step) { driver.get("http://www.example.com/"); }); });', validation_bypassed=True)