Skip to main content
POST
/
process.Process
/
Start
Start
curl --request POST \
  --url https://api.example.com/process.Process/Start \
  --header 'Content-Type: application/connect+json' \
  --data '
{
  "process": {
    "cmd": "<string>",
    "args": [
      "<string>"
    ],
    "envs": {},
    "cwd": "<string>"
  },
  "pty": {
    "size": {
      "cols": 123,
      "rows": 123
    }
  },
  "tag": "<string>",
  "stdin": true
}
'
{
  "event": {
    "data": {
      "pty": "aSDinaTvuI8gbWludGxpZnk="
    }
  }
}

Body

process
process · object
pty
pty · object
tag
string
stdin
boolean

This is optional for backwards compatibility. We default to true. New SDK versions will set this to false by default.

Response

Success

event
event · object