SpiraPlan: REST Web Service (v5.0)

See all operations

GET: automation-engines/tokens{token}


Retrieves a single automation engine record by its Token

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):


Request Parameters

Name Description
token The token of the engine

Request Body

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description
AutomationEngineId The id of the engine
Name The display name of the engine
Token The token of the engine Ths is the name that external systems should refer to it as
Description The detailed description of the engine Optional
Active Is this host active for the project