AdminOperationResponse PauseEngine(ctx, engineID, optional)
This API pauses an engine so that tasks based on this engine will not run.
Required Parameters
| Name | Type | Description | Notes |
|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| engineID | string | ID of Engine | |
| optional | *PauseEngineOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a PauseEngineOpts struct
| Name | Type | Description | Notes |
|---|
| xCorrelationId | optional.String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request | |
| pauseEngineRequest | optional.Interface of PauseEngineRequest | Engine Instance Info | |
Return type
AdminOperationResponse
Authorization
api_key
HTTP request headers
- Content-Type: application/json
- Accept: application/json
