Launcher API

The launcher (grroxy) manages projects and provides shared utilities. Default port: 8888.

CA Certificate

MethodPathAuthDescription
GET/cacert.crtNoDownload the CA certificate for HTTPS interception

Projects

MethodPathAuthDescription
GET/api/project/listNoList all projects
POST/api/project/newYesCreate a new project and start its grroxy-app instance
POST/api/project/openYesOpen an existing project by name or ID

POST /api/project/new body:

{
  "name": "my-project"
}

POST /api/project/open body:

{
  "project": "my-project"
}

Commands

MethodPathAuthDescription
POST/api/runcommandYesExecute a shell command and save output
{
  "command": "echo hello",
  "data": "",
  "saveTo": "collection",
  "collection": "cmd_output",
  "filename": ""
}

Cook

MethodPathAuthDescription
POST/api/cook/searchYesSearch available Cook patterns and methods
{
  "search": "encode"
}

Files

MethodPathAuthDescription
POST/api/readfileYesRead file from cache, config, or cwd
POST/api/savefileYesSave data to a file

POST /api/readfile body:

{
  "fileName": "output.txt",
  "folder": "cache"
}

POST /api/savefile body:

{
  "fileName": "output.txt",
  "fileData": "hello world",
  "folder": "cache"
}

File Watcher

MethodPathAuthDescription
GET/api/filewatcherNoWatch GRROXY_TEMPLATE_DIR for changes via SSE

Regex

MethodPathAuthDescription
POST/api/regexNoTest a regex pattern against a string
{
  "regex": "<title>(.*?)</title>",
  "responseBody": "<html><title>Test</title></html>"
}

SQL

MethodPathAuthDescription
POST/api/sqltestYesExecute a raw SQL query
{
  "sql": "SELECT * FROM _projects LIMIT 10"
}

Templates

MethodPathAuthDescription
GET/api/templates/listNoList all YAML template files
POST/api/templates/newNoCreate or overwrite a template file
DELETE/api/templates/:templateNoDelete a template file by name

POST /api/templates/new body:

{
  "name": "my-template.yaml",
  "content": "id: my-template
info:
  name: My Template"
}

Tools

MethodPathAuthDescription
GET/api/tool/serverNoStart or retrieve a grroxy-tool server instance by ID
GET/api/toolNoStart a new PocketBase tool instance at the given path

Updates

MethodPathAuthDescription
GET/api/update/checkNoCheck if a newer version is available
POST/api/updateNoDownload and install the latest grroxy binaries