CustomContainer stop request
Description
Stop the object specified by the <guid> in the URI.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/CustomContainer/guid/stop | void | Not applicable |
HTTP request message
Query string parameters
This API does not use query string parameters.
Request message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Request message body
This API uses the following objects in the request message body JSON.
Top-level objects
Name | Type | Multi- | Description |
|---|---|---|---|
callbackURL | String | 0..1 | URL to call when the operation finishes |
postCallout | String | 0..1 | Identifier of a callout to run after the operation executes |
preCallout | String | 0..1 | Identifier of a callout to run before the operation executes |
timeout | Integer | 0..1 | Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:
|
operationParams | 1 | Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request. |
Input parameters to include in operationParams
Name | Type | Multi- | Description |
|---|---|---|---|
actionName | String | 0..1 |
|
actionType | String | 0..1 |
|
deploymentParameterValue | 0..* |
| |
logicalDataCenter | 0..1 |
| |
mode | 0..1 |
| |
requestContext | 0..1 |
| |
softwareResource | 0..1 |
|
HTTP response message
Response message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Response message body
The response message body contains a Task object.
Unknown macro: confluence_report-block. Click on this message for details.