Stop virtual machine
POST/virtual_machines/virtual_machine/stop
Queues a task to stop a virtual machine
Scopes
virtual_machines
virtual_machines:power_actions
OAuth2 Scopes
When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/
.
Request
- application/json
Body
virtual_machine
object
required
All 'virtual_machine[]' params are mutually exclusive, only one can be provided.
Responses
- 200
- 400
- 403
- 404
- 406
- 429
- 503
Queues a task to stop a virtual machine
- application/json
- Schema
- Example (from schema)
Schema
task
object
required
Possible values: [pending
, running
, completed
, failed
]
{
"task": {
"id": "string",
"name": "string",
"status": "pending"
}
}
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [missing_api_token
]
{
"code": "missing_api_token",
"description": "string",
"detail": {}
}
403 error response
- application/json
- Schema
- Example (from schema)
Schema
- UnauthorizedNetworkForAPITokenSchema
- InvalidAPITokenSchema
- InvalidCapabilitiesTokenSchema
- ScopeNotGrantedErrorSchema
- PermissionDeniedSchema
oneOf
Network is not allowed to access the API with this API token
Possible values: [unauthorized_network_for_api_token
]
detail
object
The IP address the request was received from
The API token provided was not valid (it may not exist or have expired)
Possible values: [invalid_api_token
]
detail
object
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)
Possible values: [invalid_capabilities_token
]
The scope required for this endpoint has not been granted to the authenticating identity
Possible values: [scope_not_granted
]
detail
ScopeNotGrantedError
The authenticated identity is not permitted to perform this action
Possible values: [permission_denied
]
detail
object
Additional information regarding the reason why permission was denied
{}
No virtual machine was found matching any of the criteria provided in the arguments
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [virtual_machine_not_found
]
{
"code": "virtual_machine_not_found",
"description": "string",
"detail": {}
}
406 error response
- application/json
- Schema
- Example (from schema)
Schema
- ObjectInTrashSchema
- TaskQueueingErrorSchema
oneOf
The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation.
Possible values: [object_in_trash
]
detail
object
trash_object
object
nullable
This error means that a background task that was needed to complete your request could not be queued
Possible values: [task_queueing_error
]
detail
object
{}
You have reached the rate limit for this type of request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [rate_limit_reached
]
detail
object
The total number of requests per minute that are permitted
{
"code": "rate_limit_reached",
"description": "string",
"detail": {
"total_permitted": 0
}
}
The service is currently unavailable, please try again later
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [service_unavailable
]
{
"code": "service_unavailable",
"description": "string",
"detail": {}
}