# UtilitiesController_Ping

Tests connectivity and the version of the service.

`GET /api/v1/Utilities/Ping`

**API:** Excise Platform API
**Tag:** UtilitiesController
**API Version:** v1
**Base URL:** https://excise.avalara.com
**Accepts:** `application/json`
**Authentication:** Basic (username + license key)

Source: https://developer.avalara.com/products/excise/api/methods/UtilitiesController/UtilitiesController_Ping/

## Description

Check connectivity to the Excise Platform API and return information about the API server.
            
This API is intended to help you verify that your connection is working. This API will always succeed and will
never return an error. It provides basic information about the server you connect to:
            
* `version` - The version number of the Excise Platform API server that responded to your request.
* `authenticated` - A boolean flag indicating whether or not you sent valid credentials with your API request.
* `authenticatedUserName` - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user.

## Parameters

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `X-Avalara-Client` | string | header | No | Identifies the software you are using to call this API. For more information on the client header, see Client Headers. |

## Responses

| Status | Description | Schema |
|---|---|---|
| 200 | Returns service version information and authentication status. | `Avalara.Excise.Common.Contracts.Services.PingResponse` |

### 200 Response: `Avalara.Excise.Common.Contracts.Services.PingResponse`

Represents the response from a ping operation to verify service connectivity and authentication status.
This class is used to check if the service is available and if the current user is properly authenticated.

| Property | Type | Required | Description |
|---|---|---|---|
| `version` | string | No | Gets or sets the version of the service that responded to the ping request.
This property indicates which version of the service API is currently active. Example: `string`. |
| `authenticated` | boolean | No | Gets or sets a boolean value indicating whether the current user is authenticated.
True if the user has valid authentication credentials, false otherwise. Example: `false`. |
| `authenticatedUserName` | string | No | Gets or sets the username of the authenticated user.
This property contains the username of the currently authenticated user,
or null/empty if the user is not authenticated. Example: `string`. |

## Example Request

```bash
curl -X GET "https://excise.avalara.com/api/v1/Utilities/Ping" \
  -H "Authorization: Basic <credentials>" \
  -H "Accept: application/json"
```