Get-ProjectBadges

SYNOPSIS

List all badge URLs for tags in the Healthchecks project.

SYNTAX

__AllParameterSets

Get-ProjectBadges [-ApiKey] <string> [-BaseUrl] <string> [<CommonParameters>]

ALIASES

None

DESCRIPTION

Retrieves a map of all tags in the project, with badge URLs for each tag and format (svg, json, shields, etc.) using the API v3.

EXAMPLES

EXAMPLE 1

Get-ProjectBadges -ApiKey $apiKey -BaseUrl "https://checks.example.com"

Lists all badge URLs for the project.

PARAMETERS

-ApiKey

The Healthchecks API key for authentication.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-BaseUrl

The base URL of the Healthchecks instance.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS