Invoke-FleetDMMethod

SYNOPSIS

Invokes a custom FleetDM API method

SYNTAX

Invoke-FleetDMMethod [-Endpoint] <String> [[-Method] <String>] [[-Body] <Hashtable>]
 [[-QueryParameters] <Hashtable>] [-FollowPagination] [-Raw] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Provides direct access to any FleetDM API endpoint not covered by specific cmdlets. This is useful for accessing new or undocumented API endpoints.

EXAMPLES

EXAMPLE 1

Invoke-FleetDMMethod -Endpoint "config" -Method GET

Gets the FleetDM configuration

EXAMPLE 2

Invoke-FleetDMMethod -Endpoint "users" -Method GET -QueryParameters @{query = "admin"}

Searches for users with “admin” in their name

EXAMPLE 3

$body = @{
    name = "New Team"
    description = "Created via API"
}
Invoke-FleetDMMethod -Endpoint "teams" -Method POST -Body $body

Creates a new team

EXAMPLE 4

Invoke-FleetDMMethod -Endpoint "hosts/123/refetch" -Method POST

Triggers a refetch for host ID 123

EXAMPLE 5

Invoke-FleetDMMethod -Endpoint "labels" -Method GET -FollowPagination

Gets all labels, automatically following pagination

PARAMETERS

-Endpoint

The API endpoint path (without /api/v1/fleet/ prefix)

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Method

The HTTP method to use (GET, POST, PUT, PATCH, DELETE)

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: GET
Accept pipeline input: False
Accept wildcard characters: False

-Body

The request body as a hashtable (will be converted to JSON)

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-QueryParameters

Query parameters as a hashtable

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FollowPagination

Automatically follow pagination to retrieve all results (for GET requests)

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Raw

Return the raw response object without processing

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

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

NOTES

https://fleetdm.com/docs/using-fleet/rest-api