Add-AuvikBaseURI

SYNOPSIS

Sets the base URI for the Auvik API connection.

SYNTAX

Add-AuvikBaseURI [[-base_uri] <String>] [[-data_center] <String>] [<CommonParameters>]

DESCRIPTION

The Add-AuvikBaseURI cmdlet sets the base URI which is later used to construct the full URI for all API calls.

EXAMPLES

EXAMPLE 1

Add-AuvikBaseURI

The base URI will use https://auvikapi.us1.my.auvik.com/v1 which is Auvik’s default URI.

EXAMPLE 2

Add-AuvikBaseURI -data_center US

The base URI will use https://auvikapi.us1.my.auvik.com/v1 which is Auvik’s US URI.

EXAMPLE 3

Add-AuvikBaseURI -base_uri http://myapi.gateway.example.com

A custom API gateway of http://myapi.gateway.example.com will be used for all API calls to Auvik’s API.

PARAMETERS

-base_uri

Define the base URI for the Auvik API connection using Auvik’s URI or a custom URI.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: Https://auvikapi.us1.my.auvik.com/v1
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-data_center

Auvik’s URI connection point that can be one of the predefined data centers.

https://support.auvik.com/hc/en-us/articles/360033412992

Accepted Values: ‘au1’, ‘ca1’, ‘eu1’, ‘eu2’, ‘us1’, ‘us2’, ‘us3’, ‘us4’

Example: us3 = https://auvikapi.us3.my.auvik.com/v1

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
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

N\A

RELATED LINKS

https://celerium.github.io/Auvik-PowerShellWrapper/site/Internal/Add-AuvikBaseURI.html