network · Command reference

qzx checkUrlStatus

What it does

Pings an HTTP URL, returning its status code, response time, and basic headers

Canonical command: checkUrlStatus

Accepted aliases: None

Case-sensitive: no

Included in the published package

Available in PyPI 0.2.2.0.2. This page documents the 0.2.2.0.2 alpha development checkout.

Safety and effects

Read-only under the current classification

No documented dry-run parameter

No native program invocation in the current classification

May use the network

No inherent elevation requirement

This safety classification was reviewed against implementation digest sha256:135d95179bbfe6e9a2d631b8e025b864689e4aeded2ee385e8ce06ebb67070e0 on 2026-07-24.

Exact syntax

qzx checkUrlStatus <url> [timeout] --json

Parameters

NameTypeRequiredDefaultDescription
urlstrYesNot declaredTarget URL to check (e.g., https://api.github.com)
timeoutfloatNo5Request timeout in seconds (default: 5.0)

Input examples

qzx checkUrlStatus https://api.github.com

Verify if GitHub API is accessible and check response times

qzx checkUrlStatus https://httpbin.org/status/404 3.0

Check a URL with a custom 3-second timeout

For the complete structured payload, add --json: qzx checkUrlStatus <url> [timeout] --json

Representative output example

This illustrative JSON is derived from the current implementation-backed result contract. It shows what the command can return without claiming a recorded execution; values vary with inputs, host, permissions, and optional tools.

Example command: qzx checkUrlStatus https://api.github.com --json

{
    "success": true,
    "message": "Pings an HTTP URL, returning its status code, response time, and basic headers. In this illustrative example, the command completed successfully.",
    "headers": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "is_online": true,
    "reason": "Example value",
    "response_time_ms": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "status_code": "Example value",
    "url": "https://example.com"
}
View the JSON result contract
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "error": {
            "type": "string"
        },
        "headers": [],
        "is_online": [],
        "reason": [],
        "response_time_ms": [],
        "status_code": [],
        "url": []
    },
    "additionalProperties": true
}

Errors and limits

The public contract requires success=false and a descriptive message on failure. This catalog does not yet declare a command-specific error taxonomy; inspect the result and do not invent error codes.

QZX is alpha software. Optional dependencies, permissions, and host capabilities can change the result.

Evidence workflow: requires an authorized endpoint or reviewed fixture.

Evidence and provenance

Documentation channel
Development documentation 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Availability
0.2.2.0.2 or earlier

Keep exploring

These commands also belong to the network category. Compare them to choose the operation that best fits your task.

Explore all QZX commands