Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zimbres/merakipingapiinterface
API designed to ping functionality for devices
https://github.com/zimbres/merakipingapiinterface
Last synced: 6 days ago
JSON representation
API designed to ping functionality for devices
- Host: GitHub
- URL: https://github.com/zimbres/merakipingapiinterface
- Owner: zimbres
- License: mit
- Created: 2024-07-12T02:20:52.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-25T02:18:58.000Z (5 months ago)
- Last Synced: 2024-12-24T12:18:35.844Z (11 days ago)
- Language: C#
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Meraki Ping Api Interface
---
MerakiPingApiInterface is a simple API designed to ping functionality for devices. It offers endpoints to verify the API health and to perform ping operations on devices using their serial numbers and target addresses.
## API Version
**Version**: 1.0
## Endpoints
### Health Check
#### `GET /`
Returns the health status of the API.
- **Tags**: Health
- **Responses**:
- **200 OK**
- **Content Types**:
- `text/plain`
- `application/json`
- `text/json`
- **Schema**:
- `$ref: #/components/schemas/Health`
### Ping Device
#### `GET /Ping`
Performs a ping operation on a device using its serial number and target address.
- **Tags**: Ping
- **Parameters**:
- **deviceSerial** (query, string): The serial number of the device to be pinged.
- **target** (query, string): The target address to ping.
- **Responses**:
- **200 OK**
## Schemas
### Health
Represents the health status of the API.
- **Type**: Object
- **Properties**:
- **data**:
- **$ref: #/components/schemas/HealthData**
- **Additional Properties**: False
### HealthData
Contains the health information.
- **Type**: Object
- **Properties**:
- **health**:
- **Type**: Boolean
- **Additional Properties**: False
---
### Pre built container
>https://hub.docker.com/r/zimbres/meraki-ping-api-interface
---
A pre-compiled package is available for Windows and Linux. It requires ASP.NET Core Runtime 8.x.
[Download .NET 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)