Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Signal sends one signal to an existing process.

POST/v1/processes/{process}/signal
Signal sends one signal to an existing process. Action: a signal is delivered to a running process and leaves no representation to replace.

Connection and access

API connection and authentication guidance

{endpoint}

endpoint: The sandbox API base URL from Sandbox.core.endpoint.uri; preserve its path prefix when appending /v1 routes. HTTP endpoints require a scoped endpoint bearer; direct Unix sockets use socket access control.

Use one of these alternatives. Requirements within an alternative apply together.

  • sandboxBearer

Parameters

process path Required

The process id.

Type: string

All schema constraints and annotations
{
  "type": "string"
}

Request and responses

Request

application/json

Type: object

SignalRequest sends one signal.
signal · required

Schema: ProcessSignal

signal is the signal to send.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/ProcessSignal",
  "description": "signal is the signal to send.",
  "not": {
    "enum": [
      "unspecified"
    ]
  }
}
All schema constraints and annotations
{
  "additionalProperties": false,
  "description": "SignalRequest sends one signal.",
  "properties": {
    "signal": {
      "$ref": "#/components/schemas/ProcessSignal",
      "description": "signal is the signal to send.",
      "not": {
        "enum": [
          "unspecified"
        ]
      }
    }
  },
  "required": [
    "signal"
  ],
  "title": "SignalRequest",
  "type": "object"
}

Response 200

Success

application/json

Schema: SignalResponse

Response default

The structured Error body identifies the failure with a stable code and optional typed details.

application/json

Schema: Error

Schema example

{
  "code": "notFound",
  "details": [],
  "message": "sandbox not found"
}

Referenced schemas

#/components/schemas/Error

#/components/schemas/ProcessSignal

#/components/schemas/SignalResponse

Complete operation contract
{
  "description": "Signal sends one signal to an existing process.\nAction: a signal is delivered to a running process and leaves no representation to\nreplace.",
  "operationId": "signal",
  "parameters": [
    {
      "description": "The process id.",
      "in": "path",
      "name": "process",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "additionalProperties": false,
          "description": "SignalRequest sends one signal.",
          "properties": {
            "signal": {
              "$ref": "#/components/schemas/ProcessSignal",
              "description": "signal is the signal to send.",
              "not": {
                "enum": [
                  "unspecified"
                ]
              }
            }
          },
          "required": [
            "signal"
          ],
          "title": "SignalRequest",
          "type": "object"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SignalResponse"
          }
        }
      },
      "description": "Success"
    },
    "default": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The structured Error body identifies the failure with a stable code and optional typed details."
    }
  },
  "security": [
    {
      "sandboxBearer": []
    }
  ],
  "servers": [
    {
      "url": "{endpoint}",
      "variables": {
        "endpoint": {
          "default": "https://sandbox.invalid",
          "description": "The sandbox API base URL from Sandbox.core.endpoint.uri; preserve its path prefix when appending /v1 routes. HTTP endpoints require a scoped endpoint bearer; direct Unix sockets use socket access control."
        }
      }
    }
  ],
  "summary": "Signal sends one signal to an existing process.",
  "tags": [
    "Processes"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-plane": "data",
  "x-sbx-required-permissions": [
    "sandboxesExec"
  ],
  "x-sbx-serving-surface": "sandboxEndpoint"
}