Skip to content
URL:
https://<root>/machines/<machine>/toolstatus
Methods:
GET
Version Introduced:
12.0

Description

The toolstatus resource outputs the results from manually running the Tool Status tool. The HTML version of this page has a direct link to run the tool, otherwise it is run at the time of site creation. After running the tool via the HTML webpage, the response can be viewed in JSON. If it is unclear whether a specific function of the site is running, it is recommended to use this resource to receive a description of which tools are available.

Request parameters

ParameterDetails

f

(Required)

The output format for this operation. The only accepted value is html.

Values: html

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Response properties

PropertyDetails

testOutput

Outputs the Tool Status tool's results. Covers TerrainProbe, EsriVideoProbe, EsriKlvExtractionService, ExtractionDB, and EsriVideoMultiplexer.

success

Outputs whether or not all tool tests successfully passed. Will be false if any fail; check testOutput for feedback and further detail.

Values: true | false

Example usage

The following is a sample GET request for the toolstatus resource:

Use dark colors for code blocksCopy
1
https://organization.example.com/video/admin/machines/machine.example.com/toolstatus?f=html

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.