API Documentation
Our API allows you to access and run tests remotely. It can be used to integrate Ghost Inspector into your workflow.
Folders
- List - Fetch an array of all the folders in your account
- Get - Fetch a single folder from your account
- Create - Create a folder and return the new
- Update - Update a folder and return the updated folder
- List Suites - 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
Suite Results
- Get - Fetch a single suite result
- Cancel - Cancel an active suite run
- List Test Results - Fetch an array of test results for a suite result
- Get XUnit Report - Fetch an XML report of the suite result in XUnit v2 format
Test Results
- Get - Fetch a single test result
- Cancel - Cancel an active test run
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
Webhooks
- Test Webhook - The payload POSTed to any specified test webhook