Perform Baremetal Servers Action

Perform Baremetal Servers Action
Perform action on a batch of baremetal servers.

Perform action on a batch of baremetal servers.

Request
URI
POST
https://{api_host}/baremetal/servers
COPY
Query Parameters
string
action
Required  

Action to perform on baremetal servers.

Enumeration: BATCH_UPGRADE, BATCH_DELETE
Request Body

List of baremetal server IDs.

BaremetalServerIdList of type(s) application/json
Required   
{
    "ids": [
        "string"
    ]
}
array of string
ids
Optional

List of baremetal server ids.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns AsyncApiResponseList of type(s) application/json 
{
    "results": [
        {
            "id": "b8f47985-22ed-3193-bca8-11c7b025cbce",
            "status_url": "/operation/status"
        }
    ]
}
array of object
results
Optional

List of async api responses.


400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


default

Error response on API failure.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/baremetal/servers
On This Page
Baremetal Security Operations
GET
Get Baremetal Controller List
GET
Get Baremetal Controller Status
GET
Get Baremetal Server Status
GET
Get Baremetal Server List
POST
Perform Baremetal Servers Action
GET
Get Baremetal Server
DELETE
Uninstall Baremetal Server
GET
Get Baremetal Server Installer Bundle
GET
Get Baremetal Server Windows Agent Bundle
GET
Get Registration Token
DELETE
Delete Registration Token
GET
Get Registration Token Status
GET
Get Registration Token Statuses
POST
Create Registration Token
GET
Get Registration Tokens
GET
Get Baremetal Services Status
GET
Get Baremetal Server Summary
POST
Query Baremetal Server Details
GET
Get Baremetal Task Status