Update a Blockchain Platform Instance
put
/api/v1/blockchainPlatforms/instances/{id}
Update a Blockchain Platform instance.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Unique platform instance identifier
Request payload in JSON
Root Schema : UpdatePayload
Type:
object
Update a Blockchain Platform instance
Show Source
-
updateHSMDetails(optional):
object UpdateHSMDetails
Details required to update the HSM.
-
updateLDAPConfig(optional):
boolean
Determines whether the instance should be updated with the active LDAP configuration.
Nested Schema : UpdateHSMDetails
Type:
object
Details required to update the HSM.
Show Source
-
label(optional):
string
The partition label to use in the HSM.
-
pin(optional):
string
The Crypto Officer PIN for the partition in the HSM.
Response
Supported Media Types
- application/json
202 Response
401 Response
Unauthorized
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
404 Response
Not Found
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
409 Response
Operation conflict
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
500 Response
Internal Server Error
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
Examples
This endpoint is used to update a particular Blockchain Platform instance.
The following example shows how to update a Blockchain Platform instance by submitting a PUT request on the REST resource using cURL.
/blockchainPlatforms/instances/{id} curl -X PUT \ http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/e1f7bcfe-cc7e-4d19-97fb-772b231fcf99 \ -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \ -H 'Content-Type: application/json'
Example of the Request Body
The following example shows the contents of the request body in JSON format:
{ "updateLDAPConfig": true }
Example of the Response Body
The following example shows the contents of the response body in a JSON format:
202 Accepted