SergiyE.StatusPageIoApi
1.0.9
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package SergiyE.StatusPageIoApi --version 1.0.9
NuGet\Install-Package SergiyE.StatusPageIoApi -Version 1.0.9
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SergiyE.StatusPageIoApi" Version="1.0.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SergiyE.StatusPageIoApi" Version="1.0.9" />
<PackageReference Include="SergiyE.StatusPageIoApi" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add SergiyE.StatusPageIoApi --version 1.0.9
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SergiyE.StatusPageIoApi, 1.0.9"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package SergiyE.StatusPageIoApi@1.0.9
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=SergiyE.StatusPageIoApi&version=1.0.9
#tool nuget:?package=SergiyE.StatusPageIoApi&version=1.0.9
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
StatusPageIoApi
StatusPageIoApi is an implementation of StatusPage.io's API client in C# / .NET
Developer information
Integrate the library in own application
- Add the StatusPageIoApi NuGet package to your application.
- Use the sample code below or the test console application from here
Sample code
string apiKey = <your-api-key>;
StatusPageIoApi.ApiClient apiClient = new StatusPageIoApi.ApiClient(apiKey);
Page[] pages = await apiClient.GetPages(cancellationToken);
foreach (Page page in pages) {
//get all components on page
Component[] components = await apiClient.GetPagesComponents(page.Id, cancellationToken: cancellationToken);
//create new incident
Incident newIncident = await apiClient.PostIncidents(pageId, new PostIncident {
Incident = new CreateIncident {
Name = "The system has failed.",
Status = IncidentStatus.Identified,
DeliverNotifications = false,
Components = components.ToDictionary(c => c.Id, c => ComponentStatus.UnderMaintenance),
ComponentIds = components.Select(c => c.Id).ToArray(),
ImpactOverride = IncidentImpactOverride.Critical,
},
}, cancellationToken: cancellationToken);
//close all page incidents
Incident[] incidents = await apiClient.GetIncidents(pageId, cancellationToken: cancellationToken);
foreach (Incident incident in incidents) {
switch (incident.Status) {
case IncidentStatus.Resolved:
case IncidentStatus.Completed:
//remove old resolved incident
if (incident.ResolvedAt.HasValue && incident.ResolvedAt.Value.AddHours(1) < DateTime.UtcNow) {
await apiClient.DeleteIncident(page.Id, incident.Id, cancellationToken);
}
continue;
case IncidentStatus.Investigating:
case IncidentStatus.Identified:
case IncidentStatus.Monitoring:
incident.Status = IncidentStatus.Resolved;
break;
case IncidentStatus.Scheduled:
case IncidentStatus.InProgress:
case IncidentStatus.Verifying:
incident.Status = IncidentStatus.Completed;
break;
case null:
continue;
}
await apiClient.PatchIncident(page.Id, incident.Id, new PatchIncident {
Incident = new Incident {
Status = incident.Status,
}
}, cancellationToken: cancellationToken);
}
//patch component statuses
components = await apiClient.GetPagesComponents(page.Id, cancellationToken: cancellationToken);
foreach (Component component in components) {
if (component.Status == ComponentStatus.Operational) continue;
component.Status = ComponentStatus.Operational;
await apiClient.PatchComponent(page.Id, component.Id, new PatchComponent {
Component = new Component {
Status = ComponentStatus.Operational,
}
}, cancellationToken: cancellationToken);
}
}
This package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET Framework | net472 is compatible. net48 was computed. net481 was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETFramework 4.7.2
- Newtonsoft.Json (>= 13.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.