Push API resources Open API documentation
This C# SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0
- SDK version: 1.0.0
- Generator version: 7.6.0
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen
- RestSharp - 106.13.0 or later
- Json.NET - 13.0.2 or later
- JsonSubTypes - 1.8.0 or later
- System.ComponentModel.Annotations - 5.0.0 or later
The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:
Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations
NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.
Run the following command to generate the DLL
- [Mac/Linux]
/bin/sh build.sh
- [Windows]
build.bat
Then include the DLL (under the bin
folder) in the C# project, and use the namespaces:
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
A .nuspec
is included with the project. You can follow the Nuget quickstart to create and publish packages.
This .nuspec
uses placeholders from the .csproj
, so build the .csproj
directly:
nuget pack -Build -OutputDirectory out Org.OpenAPITools.csproj
Then, publish to a local feed or other host and consume the new package via Nuget as usual.
To use the API client with a HTTP proxy, setup a System.Net.WebProxy
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class Example
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://push.databox.com";
var apiInstance = new DefaultApi(config);
try
{
apiInstance.DataDelete();
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DataDelete: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
All URIs are relative to https://push.databox.com
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | DataDelete | DELETE /data | |
DefaultApi | DataMetricKeyDelete | DELETE /data/{metricKey} | |
DefaultApi | DataPost | POST /data | |
DefaultApi | LastpushesGet | GET /lastpushes | |
DefaultApi | MetrickeysGet | GET /metrickeys | |
DefaultApi | MetrickeysPost | POST /metrickeys | |
DefaultApi | PingGet | GET /ping | |
DefaultApi | RootPost | POST / | |
MicroProfileHealthApi | MicroprofileHealthLiveness | GET /q/health/live | The Liveness check of this application |
MicroProfileHealthApi | MicroprofileHealthReadiness | GET /q/health/ready | The Readiness check of this application |
MicroProfileHealthApi | MicroprofileHealthRoot | GET /q/health | An aggregated view of the Liveness and Readiness of this application |
- Model.ApiResponse
- Model.HealthCheckResponse
- Model.PayloadDataModel
- Model.PayloadModel
- Model.PushData
- Model.PushDataAttribute
- Model.State
Authentication schemes defined for the API:
- Type: HTTP basic authentication