Sessions
Cancel a session
Stops a queued or running session, the same as the web UI's terminate action. The session moves to terminated and the run stops on its device at the next step. A BYOD session waiting for an offline device is stopped too, so it does not resume when the device reconnects.
post/api/sessions/{sessionId}/cancel
Request
- Base URLhttps://aximo.autify.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
sessionIdstring uuid required
Session UUID to cancel.
Response
Session cancelled.
Example response
{
"success": true
}Changes
No recorded changes to this operation across all 1 revision of this API.