Get-AtriaApiContext
SYNOPSIS
Gets the current context of the Atria API connection.
SYNTAX
Get-AtriaApiContext [<CommonParameters>]
DESCRIPTION
Returns an object containing details of the current Atria API session, including the authentication token, API base URI, HTTP headers, and connection status.
The connection status (connected) indicates whether the session has an active authentication token.
PARAMETERS
<CommonParameters>
This cmdlet supports common parameters:
Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
For more information, see about_CommonParameters.
OUTPUTS
A hashtable with the following keys:
| Name | Type | Description |
|---|---|---|
| apiAuthToken | String | Current authentication token. |
| apiBaseUri | String | Base URL of the Atria API. |
| apiHeaders | Hashtable | HTTP headers used for API requests. |
| connected | Boolean | Indicates if the session is currently connected (true) or not (false). |
EXAMPLES
Example 1
PS> Get-AtriaApiContext
Retrieves and displays the current Atria API session context.
NOTES
This cmdlet relies on the connection details stored by the Connect-AtriaApi function.