VerifyAPIConnectivity
Since
v1.0.4
SYNOPSIS
Verifies connectivity to the Netbox API.
SYNTAX
VerifyAPIConnectivity [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Tests API connectivity by calling the /api/status/ endpoint, which returns Netbox version information and verifies authentication is working. This is the recommended health check endpoint for Netbox 3.x and 4.x.
EXAMPLES
EXAMPLE 1
$status = VerifyAPIConnectivity
Write-Verbose "Connected to Netbox $($status.'netbox-version')"
PARAMETERS
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
[PSCustomObject] The status response containing Netbox version info.
NOTES
AddedInVersion: v1.0.4