Edit runtime sandbox file

Replace occurrences of oldString with newString in a file in the workspace runtime sandbox, then push the change to the workspace’s default branch on GitHub. By default oldString must occur exactly once; pass replaceAll: true to replace every occurrence.

PATCH /context/runtime/content

Edit runtime sandbox file

cURL

curl --request PATCH \
  --url https://api.getcargo.io/v1/context/runtime/content \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "oldString": "<string>",
  "newString": "<string>",
  "replaceAll": true,
  "commitMessage": "<string>"
}
'

200

{
  "commit": {
    "sha": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Edit a file in the workspace runtime sandbox via string replacement, then push the change to the default branch.

path · string · required

Path of the file to edit, relative to the workspace working directory.

Minimum string length: 1

oldString · string · required

The exact substring to replace. Must occur exactly once unless replaceAll is true.

Minimum string length: 1

newString · string · required

Replacement string. May be empty to delete the match. Must differ from oldString.

replaceAll · boolean

When true, replace every occurrence of oldString instead of requiring a single match.

commitMessage · string

Optional commit message override. Defaults to 'context(runtime): edit '.

Minimum string length: 1

Response

200

application/json

Successful response

commit · Commit · object · required

Show child attributes