SimpliVity hosts API
A host is a virtual object that uses HPE OmniStack software in a federation.
OpenAPI Specification
swagger: '2.0'
info:
description: "This API enables the programmatic management of key components of an HPE SimpliVity configuration.\n\nTo access the API, request an authentication token by issuing an authentication request in the following form, where the username/password combination is a set of valid management credentials for the applicable hypervisor environment:\n\n curl -k https://simplivity@<host>/api/oauth/token -d grant_type=password -d username=<user> -d password=<pass>\n\nThen, you can pass in the resulting access_token returned in each HTTP header using Authorization: Bearer token. For example:\n\n curl -H \"Authorization: Bearer 0a08c809-17ff-479f-b0a8-aedd4d8305a0\"\n\nThe access_token times out after 10 minutes of inactivity and expires after 24 hours.\n\nMake sure to use TLS version 1.2 or greater.\n\nThere are a wide range of possible return values. Below is a list of the most common return values. \n\n 200 \"OK\" ⁃ This indicates that the request and action has completed with no issues.\n 201 \"Created\" ⁃ This indicates that the request has completed and a new resource has been created.\n 202 \"Accepted\" ⁃ This indicates that the request has been accepted for processing but the processing has not\n completed. This is a typical return when a task is generated.\n 400 \"Bad Request\" ⁃ The request cannot or will not be proccessed. Usually due to a missing required parameter\n or invalid data in the parameter.\n 401 \"Unauthorized\" ⁃ The request has not been applied because it lacks authentication credentials for the\n target resource.\n 404 \"Not Found\" ⁃ The requested target doesn't exist or has been deleted.\n 405 \"Method Not Allowed\" ⁃ The method being requested is not valid for the target it is being performed on.\n 408 \"Request Timeout\" ⁃ The response took too long.\n 500 \"Internal Server Error\" ⁃ Indicates that the server encountered an unexpected condition that prevented it\n from fulfilling the request.\n\n<a href=\"https://developer.hpe.com/platform/hpe-simplivity/home\" class=\"\toggleEndpointList\" data-id=\"errors\">Click here for a complete list of return codes and response formats</a>\n\n"
version: '1.25'
title: HPE OmniStack REST backups hosts API
contact:
name: Hewlett Packard Enterprise
license:
name: HPE OmniStack REST API
host: localhost
basePath: ''
tags:
- name: hosts
description: A host is a virtual object that uses HPE OmniStack software in a federation.
paths:
/hosts:
get:
tags:
- hosts
summary: Retrieves all hosts defined on this system
operationId: listHosts
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: show_optional_fields
in: query
description: 'An indicator to show the capacity metrics of the host
Note: These values are computed from various sources. Consequently, the retrieval of these values may adversely affect the response time of a request.'
required: false
type: boolean
default: false
- name: id
in: query
description: 'The unique identifier (UID) of the host
Accepts: Single value, comma-separated list'
required: false
type: string
- name: name
in: query
description: 'The name of the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: type
in: query
description: 'The type of host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: model
in: query
description: 'The model of the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: version
in: query
description: 'The version of the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: hypervisor_management_system
in: query
description: 'The IP address of the Hypervisor Management System (HMS) associated with the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: hypervisor_management_system_name
in: query
description: 'The name of the Hypervisor Management System (HMS) associated with the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: hypervisor_object_id
in: query
description: 'The unique identifier (UID) of the hypervisor-based instance associated with the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: compute_cluster_name
in: query
description: 'The name of the compute cluster associated with the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: compute_cluster_hypervisor_object_id
in: query
description: 'The unique identifier (UID) of the Hypervisor Management System (HMS) for the associated compute cluster
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: management_ip
in: query
description: 'The IP address of the HPE OmniStack management module that runs on the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: storage_ip
in: query
description: 'The IP address of the HPE OmniStack storage module that runs on the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: federation_ip
in: query
description: 'The IP address of the federation
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: virtual_controller_name
in: query
description: 'The name of the Virtual Controller that runs on the host
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: compute_cluster_parent_name
in: query
description: 'The name of the hypervisor-based instance that contains the omnistack_cluster that is associated with the instance
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: compute_cluster_parent_hypervisor_object_id
in: query
description: 'The unique identifier (UID) of the hypervisor-based instance that contains the omnistack_cluster that is associated with the instance
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: policy_enabled
in: query
description: 'An indicator to show the status of the backup policy for the host
Valid values:
True: The backup policy for the host is enabled.
False: The backup policy for the host is disabled.'
required: false
type: boolean
- name: current_feature_level_min
in: query
description: The minimum current feature level of the HPE OmniStack software running on the host
required: false
type: integer
format: int32
- name: current_feature_level_max
in: query
description: The maximum current feature level of the HPE OmniStack software running on the host
required: false
type: integer
format: int32
- name: potential_feature_level_min
in: query
description: The minimum potential feature level of the HPE OmniStack software running on the host
required: false
type: integer
format: int32
- name: potential_feature_level_max
in: query
description: The maximum potential feature level of the HPE OmniStack software running on the host
required: false
type: integer
format: int32
- name: cluster_feature_level_min
in: query
description: The minimum cluster feature level of the HPE OmniStack software running on the host
required: false
type: integer
format: int32
- name: cluster_feature_level_max
in: query
description: The maximum cluster feature level of the HPE OmniStack software running on the host
required: false
type: integer
format: int32
- name: upgrade_state
in: query
description: 'The state of the most recent HPE OmniStack software upgrade for this host (SUCCESS, FAIL, IN_PROGRESS, NOOP, UNKNOWN)
Accepts: Single value, comma-separated list'
required: false
type: string
- name: can_rollback
in: query
description: 'An indicator to show if the current HPE OmniStack software running on the host can roll back to the previous version
Valid values:
True: The current HPE OmniStack software for the host can roll back to the previous version.
False: The current HPE OmniStack software for the host cannot roll back to the previous version.'
required: false
type: boolean
- name: omnistack_cluster_id
in: query
description: The unique identifier (UID) of the omnistack_cluster associated with the host
required: false
type: string
- name: state
in: query
description: The current state of the host
required: false
type: string
- name: cluster_group_id
in: query
description: 'The unique identifiers (UIDs) of the cluster_groups associated with the hosts to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: availability_zone_planned
in: query
description: The planned-assigned availability zone. This will become the effectively-assigned zone once the zone changes are realized.
required: false
type: string
- name: availability_zone_effective
in: query
description: The effectively-assigned availability zone
required: false
type: string
- name: fields
in: query
description: "A comma-separated list of fields to include in the returned objects\n\n Default: Returns all fields"
required: false
type: string
- name: limit
in: query
description: 'A positive integer that represents the maximum number of results to return
Default: 500'
required: false
type: integer
default: 500
format: int32
- name: offset
in: query
description: 'A positive integer that directs the service to start returning the <offset value> instance, up to the limit
Default: 0'
required: false
type: integer
default: 0
format: int32
- name: case
in: query
description: 'An indicator that specifies if the filter and sort results use a case-sensitive or insensitive manner
Valid values: sensitive or insensitive
Default: sensitive'
required: false
type: string
default: sensitive
enum:
- sensitive
- insensitive
- name: sort
in: query
description: The name of the field where the sort occurs
required: false
type: string
- name: order
in: query
description: 'The sort order preference
Valid values: ascending or descending
Default: descending'
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/host'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/hosts/{hostId}:
get:
tags:
- hosts
summary: Retrieves the specified host
operationId: getHost
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: hostId
in: path
description: The unique identifier (UID) of the host that you want to retrieve
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/host'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/hosts/{hostId}/cancel_virtual_controller_shutdown:
post:
tags:
- hosts
summary: Cancels the shutdown of the Virtual Controller
operationId: cancelShutdownVirtualControllerUsingPOST
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: hostId
in: path
description: The unique identifier (UID) of the host
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ShutdownResponseMO'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/hosts/{hostId}/capacity:
get:
tags:
- hosts
summary: Host Capacity
operationId: getHostCapacity
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: hostId
in: path
description: The identifier of the host. This identifier is unique within the category namespace.
required: true
type: string
- name: fields
in: query
description: "A comma-separated list of fields to include in the returned objects\n\n Default: Returns all fields"
required: false
type: string
- name: time_offset
in: query
description: 'A time offset in seconds (from now) or a datetime, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
Default: 0'
required: false
type: string
default: '0'
- name: range
in: query
description: 'A range in seconds (the duration from the specified point in time)
Default: 43200'
required: false
type: integer
default: 43200
format: int64
- name: resolution
in: query
description: 'The resolution (SECOND, MINUTE, HOUR, or DAY)
Default: MINUTE'
required: false
type: string
default: MINUTE
responses:
'200':
description: OK
schema:
$ref: '#/definitions/capacity_info'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/hosts/{hostId}/hardware:
get:
tags:
- hosts
summary: Retrieves hardware information for the host
operationId: getHostHardware
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: hostId
in: path
description: The unique identifier (UID) of the host that you want to retrieve
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/host_hardware'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/hosts/{hostId}/metrics:
get:
tags:
- hosts
summary: Retrieves throughput, IOPS, and latency data for the host
operationId: getHostMetrics
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: hostId
in: path
description: The unique identifier (UID) of the host
required: true
type: string
- name: time_offset
in: query
description: 'A time offset in seconds (from now) or a datetime, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
Default: 0'
required: false
type: string
default: '0'
- name: range
in: query
description: 'A range in seconds (the duration from the specified point in time)
Default: 43200'
required: false
type: integer
default: 43200
format: int64
- name: resolution
in: query
description: 'The resolution (SECOND, MINUTE, HOUR, or DAY)
Default: MINUTE'
required: false
type: string
default: MINUTE
responses:
'200':
description: OK
schema:
$ref: '#/definitions/analytics_info'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/hosts/{hostId}/remove_from_federation:
post:
tags:
- hosts
summary: Removes the specified host from the federation. The specified hostId must not be the host executing the request.
operationId: removeHostFromFederation
consumes:
- application/vnd.simplivity.v1.19+json
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: hostId
in: path
description: The unique identifier (UID) of the host
required: true
type: string
- in: body
name: remove host from federation options
description: 'force: An indicator that specifies if the host should be removed forcefully or not.
Valid values:
True: Forces the removal of the host even if active virtual machines are present and if the host is not HA-compliant. This may cause data loss.
False: Returns an error if there are any virtual machines on the host or if the host is not HA-compliant.
Default: false'
required: true
schema:
$ref: '#/definitions/remove_from_federation'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/TaskMO'
'201':
description: Created
'202':
description: Accepted
schema:
$ref: '#/definitions/TaskMO'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/hosts/{hostId}/shutdown_virtual_controller:
post:
tags:
- hosts
summary: Shuts down the Virtual Controller safely (by reaching HA compliance) or by force
operationId: shutdownVirtualControllerUsingPOST
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: hostId
in: path
description: The unique identifier (UID) of the host
required: true
type: string
- in: body
name: host shutdown details
description: 'ha_wait: An indicator to show if the user wants to shut down the Virtual Controller safely or forcefully.
Valid values:
True: Virtual Controller waits for the virtual machines to reach HA compliance before shutting down
False: Virtual Controller forced to shut down without waiting for HA compliance
Default: True'
required: true
schema:
$ref: '#/definitions/ShutdownVirtualControllerMO'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ShutdownResponseMO'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/hosts/{hostId}/virtual_controller_shutdown_status:
get:
tags:
- hosts
summary: Retrieves the shutdown status of the Virtual Controller
operationId: getVirtualControllerShutdownStatusUsingGET
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/openapi/simplivity-hosts-api-openapi.yml