Run One-Off URL Probe from CLI
Command
Section titled “Command”php artisan uplinkr:probe:urlDescription
Section titled “Description”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
Options
Section titled “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
Section titled “Usage Examples”Simple GET request
Section titled “Simple GET request”php artisan uplinkr:probe:url --url=https://example.comPOST request with body
Section titled “POST request with body”php artisan uplinkr:probe:url \ --url=https://api.example.com/endpoint \ --method=POST \ --body='{"key":"value"}'With custom headers
Section titled “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
Section titled “Associate with project”php artisan uplinkr:probe:url \ --url=https://example.com \ --project=my-projectWith latency limit
Section titled “With latency limit”php artisan uplinkr:probe:url \ --url=https://api.example.com \ --latency=2000Force mode (skip confirmation)
Section titled “Force mode (skip confirmation)”php artisan uplinkr:probe:url --url=https://example.com --forceBehavior
Section titled “Behavior”- Validates the URL before execution
- Prompts for confirmation unless
--forceis used - Stores the probe result in the file system
- Displays result messages based on the probe outcome
Return Codes
Section titled “Return Codes”0(SUCCESS): URL probed successfully1(INVALID): Validation failed, invalid URL, or process was aborted