Update Cell Access Endpoints

Update Cell Access Endpoints

Updates the cell's endpoint certificates. Updates will cause a brief interruption in connectivity as the reconfiguration is applied. It is recommended (though not required) that the affected cell be put into maintenance mode prior to updating the cell's endpoint certificates. This is so that existing connections can gracefully handle a certificate update.

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

cellUrn


Request Body

Updated certificate references to be applied to this cell.

CellAccessEndpoints of type(s) application/json
Required
{
    "apiEndpointIP": "string",
    "apiEndpointNonSecurePort": 0,
    "apiEndpointSecurePort": 0,
    "apiSslCertRef": {
        "name": "string",
        "id": "string"
    },
    "nonSecureApiEndpoint": "string",
    "secureApiEndpoint": "string",
    "mqttEndpoint": "string",
    "jmxEndpointIP": "string",
    "jmxEndpointRmiPort": 0,
    "jmxEndpointRmiRegistryPort": 0,
    "jmxEndpoint": "string",
    "jmxSslCertRef": {
        "name": "string",
        "id": "string"
    }
}
string
apiEndpointIP
Optional

The IP address that the cell's web services (UI, API and MQTT) will bind to

integer As int32 As int32
apiEndpointNonSecurePort
Optional

Port on which the cell's non-secure socket will bind to listen for in-coming connections. Conventionally, this is port 80.

integer As int32 As int32
apiEndpointSecurePort
Optional

Port on which the cell's secure socket will bind to listen for in-coming connections. Conventionally, this is port 443.

apiSslCertRef
Required

apiSslCertRef

string
nonSecureApiEndpoint
Optional

A URL where the cell's http endpoint can be accessed.

string
secureApiEndpoint
Optional

A URL where the cell's secured https endpoint can be accessed.

string
mqttEndpoint
Optional

URL where the cell's mqtt connector can be accessed.

string
jmxEndpointIP
Optional

The IP address that the cell's JMX service will bind to

integer As int32 As int32
jmxEndpointRmiPort
Optional

Port on which the cell's JMX RMI protocol port will bind to. By default, this is port 8998.

integer As int32 As int32
jmxEndpointRmiRegistryPort
Optional

Port on which the cell's RMI Registry will bind to. By default, this is port 8999.

string
jmxEndpoint
Optional

A URL specifying the access point for the cell using JMX.

jmxSslCertRef
Required

jmxSslCertRef

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted.

Operation doesn't return any data structure