Stop a Blockchain Platform Instance
post
/api/v1/blockchainPlatforms/instances/{id}/action/stop
Stop a Blockchain Platform instance.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Unique platform instance identifier
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 stop a particular Blockchain Platform instance.
The following example shows how to start a particular Blockchain Platform instance by submitting a POST request on the REST resource using cURL.
curl -X POST \ http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/e1f7bcfe-cc7e-4d19-97fb-772b231fcf99/action/stop \ -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \ -H 'Content-Type: application/json'
Example of the Response Body
The following example shows the contents of the response body:
202 Accepted