Skip to content

Run One-Off URL Probe from CLI

Terminal window
php artisan uplinkr:probe:url

Try to reach a URL and store the response within the basic file system. This command allows you to test HTTP endpoints with various methods, headers, and body data.

TODO: Describe intension and what does s this mean

OptionTypeRequiredDefaultDescription
--urlstringYes-Target URL to probe
--projectstringNo-Optional project name to associate the probe with
--methodstringNoGETHTTP method (GET, POST, PUT, DELETE, PATCH, etc.)
--headerarrayNo-Additional headers (can be specified multiple times)
--latencyintegerNo-Maximum time in milliseconds to wait for response
--bodystringNo-JSON body as string
--forceflagNo-Force execution without confirmation
Terminal window
php artisan uplinkr:probe:url --url=https://example.com
Terminal window
php artisan uplinkr:probe:url \
--url=https://api.example.com/endpoint \
--method=POST \
--body='{"key":"value"}'
Terminal window
php artisan uplinkr:probe:url \
--url=https://api.example.com/protected \
--header="Authorization: Bearer token123" \
--header="Content-Type: application/json"
Terminal window
php artisan uplinkr:probe:url \
--url=https://example.com \
--project=my-project
Terminal window
php artisan uplinkr:probe:url \
--url=https://api.example.com \
--latency=2000
Terminal window
php artisan uplinkr:probe:url --url=https://example.com --force
  • Validates the URL before execution
  • Prompts for confirmation unless --force is used
  • Stores the probe result in the file system
  • Displays result messages based on the probe outcome
  • 0 (SUCCESS): URL probed successfully
  • 1 (INVALID): Validation failed, invalid URL, or process was aborted