Skip to content
Logic.Monitor PowerShell Module

Get-LMAPIToken

Syntax

Section titled “Syntax”

All (Default)

Section titled “All (Default)”
Terminal window
Get-LMAPIToken [-Type <string>] [-BatchSize <int>] [<CommonParameters>]

AdminId

Section titled “AdminId”
Terminal window
Get-LMAPIToken [-AdminId <int>] [-Type <string>] [-BatchSize <int>] [<CommonParameters>]

Id

Section titled “Id”
Terminal window
Get-LMAPIToken [-Id <int>] [-Type <string>] [-BatchSize <int>] [<CommonParameters>]

AccessId

Section titled “AccessId”
Terminal window
Get-LMAPIToken [-AccessId <string>] [-Type <string>] [-BatchSize <int>] [<CommonParameters>]

Filter

Section titled “Filter”
Terminal window
Get-LMAPIToken [-Filter <Object>] [-Type <string>] [-BatchSize <int>] [<CommonParameters>]

Description

Section titled “Description”

The Get-LMAPIToken function retrieves API tokens from LogicMonitor based on specified criteria. It can return tokens by admin ID, token ID, access ID, or using filters.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Retrieve tokens for a specific admin
Get-LMAPIToken -AdminId 1234

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Retrieve a specific token by ID
Get-LMAPIToken -Id 5678

EXAMPLE 3

Section titled “EXAMPLE 3”
Terminal window
#Retrieve bearer tokens only
Get-LMAPIToken -Type "Bearer"

Parameters

Section titled “Parameters”

-AccessId

Section titled “-AccessId”

The access ID of the specific API token to retrieve. Part of a mutually exclusive parameter set.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: AccessId
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-AdminId

Section titled “-AdminId”

The ID of the admin to retrieve tokens for. Part of a mutually exclusive parameter set.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: AdminId
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-BatchSize

Section titled “-BatchSize”

The number of results to return per request. Must be between 1 and 1000. Defaults to 1000.

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

-Filter

Section titled “-Filter”

A filter object to apply when retrieving tokens. Part of a mutually exclusive parameter set.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Filter
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

Section titled “-Id”

The ID of the specific API token to retrieve. Part of a mutually exclusive parameter set.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Id
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Type

Section titled “-Type”

The type of token to retrieve. Valid values are “LMv1”, “Bearer”, "". Defaults to "".

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

CommonParameters

Section titled “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.