Call the HyperView REST API from your own code, for CI pipelines, test suites, or your own product. The Integration screen gives you a complete working example in your language.
Before you start
An API key of type Automation. See API keys and their permissions.
Step 1 - Get the example for your language
Step 1 on the screen explains the API key you need. The key also decides which systems your code can reach and what it can do there.
Choose your language: Bash, Python, Node.js, Go, PowerShell or Ruby.
Click Copy.
The example signs in, finds a system by name, opens a session, signs a user in if needed, takes a screenshot, and closes the session. Your account UUID is already filled in.
Step 2 - Fill in your details
Replace these placeholders in the example:
<your-api-key>: your API key.<system-name>: the system to work on.The system's sign-in user name and password, if it might be signed out.
NOTE: Don't commit the API key to source control. Read it from an environment variable or a secret store instead.
Step 3 - Run it
Run the example. It should save a screenshot of the system and close its session.
Full API reference
Every endpoint is documented at https://<your-console>/api/docs#/automation. The page is generated from the live API, so it's always current.
For error codes, see the Error and status message index.