Update Cell

Update Cell

Updates the cell, allowing the cell's status to be changed. This can be used to place an active cell into maintenance mode or quiesced mode, or vice versa.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/cells/{cellUrn}
COPY
Path Parameters
string
cellUrn
Required

cellUrn

string
cellUrn
Required

cellUrn

Request Body

This is the updated cell. Only the status property can be modified.

Cell of type(s) application/json
Required 
{
    "id": "string",
    "productBuildDate": "string",
    "isActive": false,
    "name": "string",
    "primaryIP": "string",
    "productVersion": "string",
    "status": "string"
}
string
id
Optional

The unique id of the cell.

string As date-time As date-time
productBuildDate
Optional

The build date for the version of the product installed on this cell.

boolean
isActive
Optional

Cell active state.

string
name
Optional

The name of the cell.

string
primaryIP
Optional

The primary ip address of the cell. This value will always match the secure api endpoint (apiEndpointIP) field in the the list of endpoints returned by the accessEndpoints API.

string
productVersion
Optional

The product version of the cell.

string
status
Required

Indicates the status of the cell. Possible values are:

  • ACTIVE
  • MAINTENANCE
  • QUIESCED
  • INACTIVE (Note: this value cannot be set via the API)
Authentication
This operation uses the following authentication methods.
Responses
202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

400

Invalid configuration.

Returns Error of type(s) */*;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 38.1
On This Page
Cell Operations
DELETE
Delete Cell
GET
Get Cell
GET
Get Cell Access Endpoints
GET
Get Cell Group Current Topology Status
GET
Get Cell Group Topology Status
GET
Get Cell Topology History
GET
Query Cells
PUT
Update Cell
PUT
Update Cell Access Endpoints