Boomi Platform API Reference (1.0.0) - RuntimeRestartRequest

Toggle Pane

• RuntimeRestartRequest
  • postCreates a RuntimeRestartRequest object

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

RuntimeRestartRequest

The RuntimeRestartRequest object allows you to restart the runtime when performing runtime maintenance or configuration. Restarting runtime is captured in the audit log entries.

Note: You must have the Runtime Management and Environment Management privileges to restart the runtime.

Creates a RuntimeRestartRequest object

Restarts the runtime.

• The client sends a runtime restart request to the platform API that specifies the runtimeId that you want to restart.
• The platform returns the status code and message while the request is in progress. A successful response implies the restart request was submitted, not when the runtime restart is completed.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

message	string
runtimeId	string A unique ID for the runtime. Cloud attachments cannot be restarted.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

message	string
runtimeId	string A unique ID for the runtime. Cloud attachments cannot be restarted.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeRestartRequest

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "runtimeId": "3456789a-bcde-f012-3456-789abcdef012"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "RuntimeRestartRequest",
• "statusCode": 200,
• "message": "Restart request submitted for runtimeId `3456789a-bcde-f012-3456-789abcdef012`. Use the Atom object to retrieve the current runtime status."

}