Unassign device(s) from a group

post/compute-ops-mgmt/v1beta3/groups/{group-id}/devices/unassign

Unassign device(s) from a group using an asynchronous operation. On a successful request this endpoint will return a 202 Accepted response with a Location header that contains the resource URI of the operation. That resource URI can then be used to monitor the asynchronous operation's status.

SecurityBearer
Request
path Parameters
group-id
required
string <uuid>
query Parameters
force
boolean
Default: false

If set to true, all devices will be unassigned from the group specified by the group-id. When this is true, do not provide a request body.

reset-subsystems
Array of strings
Default: []

After the device is removed from its group, this option initiates a job to factory reset the specified Redfish subsystem(s). This option is only valid for DIRECT_CONNECT_SERVER devices and "BIOS" is the only supported subsystem.

header Parameters
Tenant-Acid
string <uuid>

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Request Body schema: application/json
optional

A request body containing devices is required if the force query parameter is not set to true. If force is true, then no body should be provided.

required
Array of objects (deviceRemoveRequest-v1beta3) non-empty
Responses
202

Successful Response

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

415

Unsupported media type

500

Internal server error

Request samples
application/json
{
  • "devices": [
    ]
}
Response samples
application/json
{
  • "httpStatusCode": 400,
  • "errorCode": "HPE-GL-COMPUTE_OPS-0500001",
  • "message": "string",
  • "debugId": "string",
  • "errorDetails": [
    ]
}