Our API allows you to access and run tests remotely. It can be used to integrate Ghost Inspector into your workflow.
Tests
- List Tests – Fetch an array of all the tests in your account
- Get Test – Fetch a single test from your account
- Update Test – Update a test and return the updated test
- Duplicate Test – Duplicate a single test and return the new test
- Delete Test – Delete a test
- Execute Test – Execute a single test in your account and return the result
- Execute On-demand Test – Execute an on-demand test using JSON from your file system or repository
- Get Running Results for Test – Fetch a list of the currently-executing results for this test
- Accept Screenshot for Test – Accept a screenshot as the new baseline for the test
- List Test Results – Fetch an array of test results for a test
- List Test Results in CSV Format – Fetch a CSV formatted export of test results for a test
- Download Test in Selenium Builder Format (.json) – Download a single test in Ghost Inspector format (.json)
- Download Test in Selenium IDE Format (.side) – Download a single test in Selenium IDE format (.side)
- Download Test in Selenium IDE Format (.html) – Download a single test in Selenium IDE format (.html)
- Test Status Badge – Real-time embeddable status badge for your test
Test Results
- Get Test Result – Fetch a single test result
- Cancel Test Result – Cancel an active test run
Suites
- List Suites – Fetch an array of all the suites in your account
- Get Suite – Fetch a single suite from your account
- Delete Suite – Delete a suite
- Execute Suite – Execute all the tests in a suite and returns an array of results
- Create Suite – Create a suite and return the new suite
- Update Suite – Update a suite and return the updated suite
- Duplicate Suite – Duplicate a suite and return the new suite
- List Tests in Suite – Fetch an array of all the tests in a suite
- List Suite Results – Fetch an array of suite results for a suite
- List Suite Results in CSV Format – Fetch a CSV formatted export of suite results for a suite
- Import Ghost Inspector test (.json file) – Import a test in Ghost Inspector JSON format
- Import Selenium IDE test (.html file)) – Import a test in Selenium IDE’s HTML format
- Import Selenium IDE tests (.side file) – Import tests in Selenium IDE’s JSON format
- Download Suite in Ghost Inspector Format (.json) – Download a zip file of all tests in Ghost Inspector format (.json)
- Download Suite in Selenium IDE Format (.side) – Download suite in Selenium IDE format (.side)
- Download Suite in Selenium IDE Format (.html) – Download a zip file of all tests in Selenium IDE format (.html)
- Suite Status Badge – Real-time embeddable status badge for your suite
Suite Results
- Get Suite Result – Fetch a single suite result
- Cancel Suite Result – Cancel an active suite run
- List Test Results in Suite Result – Fetch an array of test results for a suite result
- Get XUnit Report for Suite Result – Fetch an XML report of the suite result in XUnit v2 format
Folders
- List Folders – Fetch an array of all the folders in your account
- Get Folder – Fetch a single folder from your account
- Create Folder – Create a folder and return the new
- Update Folder – Update a folder and return the updated folder
- List Suites in Folder – Fetch an array of all the suites in a folder
Organizations
- Get Running – Fetch a list of the currently-executing results for the entire organization
Webhooks
- Test Webhook – The payload POSTed to any specified test webhook
Test Runner IP Addresses
- Test Runner IP Addresses – Display a list of IP addresses for our test runner infrastructure by region.
Rate Limits
- Rate Limits – The API access rates allowed by the system
Errors
- Authentication – The error that is returned when authentication fails
- Validation – The error that is returned when the request is not valid
- Timeout – The error that is returned when the request times out before completing
- Server Problem – The error that is returned when the Ghost Inspector service is encountering problems
