SpiraPlan: REST Web Service (v4.0)

See all operations

GET: projects/{project_id}/automation-hosts/tokens/{token}


Retrieves a single automation host by its token name

Token names are only unique within a project

How to Execute

To access this REST web service, you need to use the following URL:


Request Parameters

Name Description
project_id The id of the current project
token The automation host's token name

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
AutomationHostId The id of the host
Name The name of the host
Token The token of the host Ths is the name that external systems should refer to it as
Description The detailed description of the host Optional
LastUpdateDate The date/time that the host was last modified This field needs to match the values retrieved to ensure data-concurrency
Active Is this host active for the project
LastContactDate The last date/time that this host was contacted
ProjectId The id of the project that the artifact belongs to The current project is always used for Insert operations for security reasons
ArtifactTypeId The type of artifact that we have (read-only)
ConcurrencyDate The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties The list of associated custom properties/fields for this artifact