Send SIGTERM to a process.
Source:
sandbox-agent/docs/content/docs/api-reference/operations/post_v1_process_stop.mdxCanonical URL: https://rivet.dev/sandbox-agent/docs/api-reference/operations/post_v1_process_stop Description: POST /v1/processes/{id}/stop: request parameters and responses.
POST /v1/processes/{id}/stop
Sends SIGTERM to the process and optionally waits up to waitMs
milliseconds for the process to exit before returning.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id |
path | Yes | string | Process ID |
waitMs |
query | No | integer | Wait up to N ms for process to exit |
Parameter schemas
[
{
"name": "id",
"in": "path",
"description": "Process ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "waitMs",
"in": "query",
"description": "Wait up to N ms for process to exit",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"nullable": true,
"minimum": 0
}
}
]Responses
200
Stop signal sent
Content type: application/json
{
"schema": {
"$ref": "#/components/schemas/ProcessInfo"
}
}Related schemas: ProcessInfo.
404
Unknown process
Content type: application/json
{
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}Related schemas: ProblemDetails.
501
Process API unsupported on this platform
Content type: application/json
{
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}Related schemas: ProblemDetails.