Run One-Off URL Probe from CLI

Command

php artisan uplinkr:probe:url

Description

Tries to reach a URL and stores the probe result in Uplinkr’s file-based storage. This command is useful for one-off checks, debugging endpoints, and validating request options such as method, headers, body data, and latency threshold.

Options

Option	Type	Required	Default	Description
--url	string	Yes	-	Target URL to probe
--project	string	No	-	Optional project name to associate the probe with
--method	string	No	GET	HTTP method (GET, POST, PUT, DELETE, PATCH, etc.)
--header	array	No	-	Additional headers (can be specified multiple times)
--latency	integer	No	-	Maximum time in milliseconds to wait for response
--body	string	No	-	JSON body as string
--force	flag	No	-	Force execution without confirmation

Usage Examples

Simple GET request

php artisan uplinkr:probe:url --url=https://example.com

POST request with body

php artisan uplinkr:probe:url \
  --url=https://api.example.com/endpoint \
  --method=POST \
  --body='{"key":"value"}'

With custom headers

php artisan uplinkr:probe:url \
  --url=https://api.example.com/protected \
  --header="Authorization: Bearer token123" \
  --header="Content-Type: application/json"

Associate with project

php artisan uplinkr:probe:url \
  --url=https://example.com \
  --project=my-project

With latency limit

php artisan uplinkr:probe:url \
  --url=https://api.example.com \
  --latency=2000

Force mode (skip confirmation)

php artisan uplinkr:probe:url --url=https://example.com --force

Behavior

• 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

Return Codes

• 0 (SUCCESS): URL probed successfully
• 2 (INVALID): Validation failed, invalid URL, or process was aborted