Class DomainMonitorControllerApi
Represents a collection of functions to interact with the API endpoints
Implements
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class DomainMonitorControllerApi : IDomainMonitorControllerApi, IDomainMonitorControllerApiSync, IDomainMonitorControllerApiAsync, IApiAccessor
Constructors
View SourceDomainMonitorControllerApi()
Initializes a new instance of the DomainMonitorControllerApi class.
Declaration
public DomainMonitorControllerApi()
DomainMonitorControllerApi(string)
Initializes a new instance of the DomainMonitorControllerApi class.
Declaration
public DomainMonitorControllerApi(string basePath)
Parameters
| Type | Name | Description |
|---|---|---|
| string | basePath |
DomainMonitorControllerApi(Configuration)
Initializes a new instance of the DomainMonitorControllerApi class using Configuration object
Declaration
public DomainMonitorControllerApi(Configuration configuration)
Parameters
| Type | Name | Description |
|---|---|---|
| Configuration | configuration | An instance of Configuration |
DomainMonitorControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)
Initializes a new instance of the DomainMonitorControllerApi class using a Configuration object and client instance.
Declaration
public DomainMonitorControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)
Parameters
| Type | Name | Description |
|---|---|---|
| ISynchronousClient | client | The client interface for synchronous API access. |
| IAsynchronousClient | asyncClient | The client interface for asynchronous API access. |
| IReadableConfiguration | configuration | The configuration object. |
Properties
View SourceAsynchronousClient
The client for accessing this underlying API asynchronously.
Declaration
public IAsynchronousClient AsynchronousClient { get; set; }
Property Value
| Type | Description |
|---|---|
| IAsynchronousClient |
Client
The client for accessing this underlying API synchronously.
Declaration
public ISynchronousClient Client { get; set; }
Property Value
| Type | Description |
|---|---|
| ISynchronousClient |
Configuration
Gets or sets the configuration object
Declaration
public IReadableConfiguration Configuration { get; set; }
Property Value
| Type | Description |
|---|---|
| IReadableConfiguration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
| Type | Description |
|---|---|
| ExceptionFactory |
Methods
View SourceCreateDomainMonitor(CreateDomainMonitorOptions, int)
Create domain monitor
Declaration
public DomainMonitorDto CreateDomainMonitor(CreateDomainMonitorOptions createDomainMonitorOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateDomainMonitorOptions | createDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| DomainMonitorDto | DomainMonitorDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateDomainMonitorAlertSink(Guid, CreateDomainMonitorAlertSinkOptions, int)
Create alert sink for monitor
Declaration
public DomainMonitorAlertSinkDto CreateDomainMonitorAlertSink(Guid monitorId, CreateDomainMonitorAlertSinkOptions createDomainMonitorAlertSinkOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| CreateDomainMonitorAlertSinkOptions | createDomainMonitorAlertSinkOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| DomainMonitorAlertSinkDto | DomainMonitorAlertSinkDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateDomainMonitorAlertSinkAsync(Guid, CreateDomainMonitorAlertSinkOptions, int, CancellationToken)
Create alert sink for monitor
Declaration
public Task<DomainMonitorAlertSinkDto> CreateDomainMonitorAlertSinkAsync(Guid monitorId, CreateDomainMonitorAlertSinkOptions createDomainMonitorAlertSinkOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| CreateDomainMonitorAlertSinkOptions | createDomainMonitorAlertSinkOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<DomainMonitorAlertSinkDto> | Task of DomainMonitorAlertSinkDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateDomainMonitorAlertSinkWithHttpInfo(Guid, CreateDomainMonitorAlertSinkOptions, int)
Create alert sink for monitor
Declaration
public ApiResponse<DomainMonitorAlertSinkDto> CreateDomainMonitorAlertSinkWithHttpInfo(Guid monitorId, CreateDomainMonitorAlertSinkOptions createDomainMonitorAlertSinkOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| CreateDomainMonitorAlertSinkOptions | createDomainMonitorAlertSinkOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<DomainMonitorAlertSinkDto> | ApiResponse of DomainMonitorAlertSinkDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateDomainMonitorAlertSinkWithHttpInfoAsync(Guid, CreateDomainMonitorAlertSinkOptions, int, CancellationToken)
Create alert sink for monitor
Declaration
public Task<ApiResponse<DomainMonitorAlertSinkDto>> CreateDomainMonitorAlertSinkWithHttpInfoAsync(Guid monitorId, CreateDomainMonitorAlertSinkOptions createDomainMonitorAlertSinkOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| CreateDomainMonitorAlertSinkOptions | createDomainMonitorAlertSinkOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<DomainMonitorAlertSinkDto>> | Task of ApiResponse (DomainMonitorAlertSinkDto) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateDomainMonitorAsync(CreateDomainMonitorOptions, int, CancellationToken)
Create domain monitor
Declaration
public Task<DomainMonitorDto> CreateDomainMonitorAsync(CreateDomainMonitorOptions createDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateDomainMonitorOptions | createDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<DomainMonitorDto> | Task of DomainMonitorDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateDomainMonitorWithHttpInfo(CreateDomainMonitorOptions, int)
Create domain monitor
Declaration
public ApiResponse<DomainMonitorDto> CreateDomainMonitorWithHttpInfo(CreateDomainMonitorOptions createDomainMonitorOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateDomainMonitorOptions | createDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<DomainMonitorDto> | ApiResponse of DomainMonitorDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateDomainMonitorWithHttpInfoAsync(CreateDomainMonitorOptions, int, CancellationToken)
Create domain monitor
Declaration
public Task<ApiResponse<DomainMonitorDto>> CreateDomainMonitorWithHttpInfoAsync(CreateDomainMonitorOptions createDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateDomainMonitorOptions | createDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<DomainMonitorDto>> | Task of ApiResponse (DomainMonitorDto) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteDomainMonitor(Guid, int)
Delete domain monitor
Declaration
public void DeleteDomainMonitor(Guid monitorId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteDomainMonitorAlertSink(Guid, Guid, int)
Delete monitor alert sink
Declaration
public void DeleteDomainMonitorAlertSink(Guid monitorId, Guid sinkId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| Guid | sinkId | |
| int | operationIndex | Index associated with the operation. |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteDomainMonitorAlertSinkAsync(Guid, Guid, int, CancellationToken)
Delete monitor alert sink
Declaration
public Task DeleteDomainMonitorAlertSinkAsync(Guid monitorId, Guid sinkId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| Guid | sinkId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task | Task of void |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteDomainMonitorAlertSinkWithHttpInfo(Guid, Guid, int)
Delete monitor alert sink
Declaration
public ApiResponse<object> DeleteDomainMonitorAlertSinkWithHttpInfo(Guid monitorId, Guid sinkId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| Guid | sinkId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteDomainMonitorAlertSinkWithHttpInfoAsync(Guid, Guid, int, CancellationToken)
Delete monitor alert sink
Declaration
public Task<ApiResponse<object>> DeleteDomainMonitorAlertSinkWithHttpInfoAsync(Guid monitorId, Guid sinkId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| Guid | sinkId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<object>> | Task of ApiResponse |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteDomainMonitorAsync(Guid, int, CancellationToken)
Delete domain monitor
Declaration
public Task DeleteDomainMonitorAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task | Task of void |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteDomainMonitorWithHttpInfo(Guid, int)
Delete domain monitor
Declaration
public ApiResponse<object> DeleteDomainMonitorWithHttpInfo(Guid monitorId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteDomainMonitorWithHttpInfoAsync(Guid, int, CancellationToken)
Delete domain monitor
Declaration
public Task<ApiResponse<object>> DeleteDomainMonitorWithHttpInfoAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<object>> | Task of ApiResponse |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
| Type | Description |
|---|---|
| string | The base path |
GetDomainMonitor(Guid, int)
Get domain monitor
Declaration
public DomainMonitorDto GetDomainMonitor(Guid monitorId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| DomainMonitorDto | DomainMonitorDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorAlertSinks(Guid, int)
List alert sinks for monitor
Declaration
public List<DomainMonitorAlertSinkDto> GetDomainMonitorAlertSinks(Guid monitorId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| List<DomainMonitorAlertSinkDto> | List<DomainMonitorAlertSinkDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorAlertSinksAsync(Guid, int, CancellationToken)
List alert sinks for monitor
Declaration
public Task<List<DomainMonitorAlertSinkDto>> GetDomainMonitorAlertSinksAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<DomainMonitorAlertSinkDto>> | Task of List<DomainMonitorAlertSinkDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorAlertSinksWithHttpInfo(Guid, int)
List alert sinks for monitor
Declaration
public ApiResponse<List<DomainMonitorAlertSinkDto>> GetDomainMonitorAlertSinksWithHttpInfo(Guid monitorId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<List<DomainMonitorAlertSinkDto>> | ApiResponse of List<DomainMonitorAlertSinkDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorAlertSinksWithHttpInfoAsync(Guid, int, CancellationToken)
List alert sinks for monitor
Declaration
public Task<ApiResponse<List<DomainMonitorAlertSinkDto>>> GetDomainMonitorAlertSinksWithHttpInfoAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<List<DomainMonitorAlertSinkDto>>> | Task of ApiResponse (List<DomainMonitorAlertSinkDto>) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorAsync(Guid, int, CancellationToken)
Get domain monitor
Declaration
public Task<DomainMonitorDto> GetDomainMonitorAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<DomainMonitorDto> | Task of DomainMonitorDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorInsights(Guid, DateTime?, DateTime?, int)
Get monitor insights
Declaration
public DomainMonitorInsightsDto GetDomainMonitorInsights(Guid monitorId, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| DomainMonitorInsightsDto | DomainMonitorInsightsDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorInsightsAsync(Guid, DateTime?, DateTime?, int, CancellationToken)
Get monitor insights
Declaration
public Task<DomainMonitorInsightsDto> GetDomainMonitorInsightsAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<DomainMonitorInsightsDto> | Task of DomainMonitorInsightsDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorInsightsWithHttpInfo(Guid, DateTime?, DateTime?, int)
Get monitor insights
Declaration
public ApiResponse<DomainMonitorInsightsDto> GetDomainMonitorInsightsWithHttpInfo(Guid monitorId, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<DomainMonitorInsightsDto> | ApiResponse of DomainMonitorInsightsDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorInsightsWithHttpInfoAsync(Guid, DateTime?, DateTime?, int, CancellationToken)
Get monitor insights
Declaration
public Task<ApiResponse<DomainMonitorInsightsDto>> GetDomainMonitorInsightsWithHttpInfoAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<DomainMonitorInsightsDto>> | Task of ApiResponse (DomainMonitorInsightsDto) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorRuns(Guid, DateTime?, DateTime?, string, int?, int)
List monitor runs
Declaration
public List<DomainMonitorRunDto> GetDomainMonitorRuns(Guid monitorId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| string | status | (optional) |
| int? | limit | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| List<DomainMonitorRunDto> | List<DomainMonitorRunDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorRunsAsync(Guid, DateTime?, DateTime?, string, int?, int, CancellationToken)
List monitor runs
Declaration
public Task<List<DomainMonitorRunDto>> GetDomainMonitorRunsAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| string | status | (optional) |
| int? | limit | (optional) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<DomainMonitorRunDto>> | Task of List<DomainMonitorRunDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorRunsWithHttpInfo(Guid, DateTime?, DateTime?, string, int?, int)
List monitor runs
Declaration
public ApiResponse<List<DomainMonitorRunDto>> GetDomainMonitorRunsWithHttpInfo(Guid monitorId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| string | status | (optional) |
| int? | limit | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<List<DomainMonitorRunDto>> | ApiResponse of List<DomainMonitorRunDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorRunsWithHttpInfoAsync(Guid, DateTime?, DateTime?, string, int?, int, CancellationToken)
List monitor runs
Declaration
public Task<ApiResponse<List<DomainMonitorRunDto>>> GetDomainMonitorRunsWithHttpInfoAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| string | status | (optional) |
| int? | limit | (optional) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<List<DomainMonitorRunDto>>> | Task of ApiResponse (List<DomainMonitorRunDto>) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorSeries(Guid, DateTime?, DateTime?, string, int)
Get monitor trend series
Declaration
public DomainMonitorSeriesDto GetDomainMonitorSeries(Guid monitorId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| string | bucket | (optional, default to DAY) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| DomainMonitorSeriesDto | DomainMonitorSeriesDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorSeriesAsync(Guid, DateTime?, DateTime?, string, int, CancellationToken)
Get monitor trend series
Declaration
public Task<DomainMonitorSeriesDto> GetDomainMonitorSeriesAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| string | bucket | (optional, default to DAY) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<DomainMonitorSeriesDto> | Task of DomainMonitorSeriesDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorSeriesWithHttpInfo(Guid, DateTime?, DateTime?, string, int)
Get monitor trend series
Declaration
public ApiResponse<DomainMonitorSeriesDto> GetDomainMonitorSeriesWithHttpInfo(Guid monitorId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| string | bucket | (optional, default to DAY) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<DomainMonitorSeriesDto> | ApiResponse of DomainMonitorSeriesDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorSeriesWithHttpInfoAsync(Guid, DateTime?, DateTime?, string, int, CancellationToken)
Get monitor trend series
Declaration
public Task<ApiResponse<DomainMonitorSeriesDto>> GetDomainMonitorSeriesWithHttpInfoAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| DateTime? | since | (optional) |
| DateTime? | before | (optional) |
| string | bucket | (optional, default to DAY) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<DomainMonitorSeriesDto>> | Task of ApiResponse (DomainMonitorSeriesDto) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorWithHttpInfo(Guid, int)
Get domain monitor
Declaration
public ApiResponse<DomainMonitorDto> GetDomainMonitorWithHttpInfo(Guid monitorId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<DomainMonitorDto> | ApiResponse of DomainMonitorDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorWithHttpInfoAsync(Guid, int, CancellationToken)
Get domain monitor
Declaration
public Task<ApiResponse<DomainMonitorDto>> GetDomainMonitorWithHttpInfoAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<DomainMonitorDto>> | Task of ApiResponse (DomainMonitorDto) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitors(int)
List domain monitors
Declaration
public List<DomainMonitorDto> GetDomainMonitors(int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| List<DomainMonitorDto> | List<DomainMonitorDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorsAsync(int, CancellationToken)
List domain monitors
Declaration
public Task<List<DomainMonitorDto>> GetDomainMonitorsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<DomainMonitorDto>> | Task of List<DomainMonitorDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorsWithHttpInfo(int)
List domain monitors
Declaration
public ApiResponse<List<DomainMonitorDto>> GetDomainMonitorsWithHttpInfo(int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<List<DomainMonitorDto>> | ApiResponse of List<DomainMonitorDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetDomainMonitorsWithHttpInfoAsync(int, CancellationToken)
List domain monitors
Declaration
public Task<ApiResponse<List<DomainMonitorDto>>> GetDomainMonitorsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<List<DomainMonitorDto>>> | Task of ApiResponse (List<DomainMonitorDto>) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
RunDomainMonitorNow(Guid, int)
Run monitor now
Declaration
public DomainMonitorRunNowResult RunDomainMonitorNow(Guid monitorId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| DomainMonitorRunNowResult | DomainMonitorRunNowResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
RunDomainMonitorNowAsync(Guid, int, CancellationToken)
Run monitor now
Declaration
public Task<DomainMonitorRunNowResult> RunDomainMonitorNowAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<DomainMonitorRunNowResult> | Task of DomainMonitorRunNowResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
RunDomainMonitorNowWithHttpInfo(Guid, int)
Run monitor now
Declaration
public ApiResponse<DomainMonitorRunNowResult> RunDomainMonitorNowWithHttpInfo(Guid monitorId, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<DomainMonitorRunNowResult> | ApiResponse of DomainMonitorRunNowResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
RunDomainMonitorNowWithHttpInfoAsync(Guid, int, CancellationToken)
Run monitor now
Declaration
public Task<ApiResponse<DomainMonitorRunNowResult>> RunDomainMonitorNowWithHttpInfoAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<DomainMonitorRunNowResult>> | Task of ApiResponse (DomainMonitorRunNowResult) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
RunDueDomainMonitors(int?, int)
Run due monitors for user
Declaration
public DomainMonitorRunDueResult RunDueDomainMonitors(int? maxRuns = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| int? | maxRuns | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| DomainMonitorRunDueResult | DomainMonitorRunDueResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
RunDueDomainMonitorsAsync(int?, int, CancellationToken)
Run due monitors for user
Declaration
public Task<DomainMonitorRunDueResult> RunDueDomainMonitorsAsync(int? maxRuns = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int? | maxRuns | (optional) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<DomainMonitorRunDueResult> | Task of DomainMonitorRunDueResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
RunDueDomainMonitorsWithHttpInfo(int?, int)
Run due monitors for user
Declaration
public ApiResponse<DomainMonitorRunDueResult> RunDueDomainMonitorsWithHttpInfo(int? maxRuns = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| int? | maxRuns | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<DomainMonitorRunDueResult> | ApiResponse of DomainMonitorRunDueResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
RunDueDomainMonitorsWithHttpInfoAsync(int?, int, CancellationToken)
Run due monitors for user
Declaration
public Task<ApiResponse<DomainMonitorRunDueResult>> RunDueDomainMonitorsWithHttpInfoAsync(int? maxRuns = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int? | maxRuns | (optional) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<DomainMonitorRunDueResult>> | Task of ApiResponse (DomainMonitorRunDueResult) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
UpdateDomainMonitor(Guid, UpdateDomainMonitorOptions, int)
Update domain monitor
Declaration
public DomainMonitorDto UpdateDomainMonitor(Guid monitorId, UpdateDomainMonitorOptions updateDomainMonitorOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| UpdateDomainMonitorOptions | updateDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| DomainMonitorDto | DomainMonitorDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
UpdateDomainMonitorAsync(Guid, UpdateDomainMonitorOptions, int, CancellationToken)
Update domain monitor
Declaration
public Task<DomainMonitorDto> UpdateDomainMonitorAsync(Guid monitorId, UpdateDomainMonitorOptions updateDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| UpdateDomainMonitorOptions | updateDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<DomainMonitorDto> | Task of DomainMonitorDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
UpdateDomainMonitorWithHttpInfo(Guid, UpdateDomainMonitorOptions, int)
Update domain monitor
Declaration
public ApiResponse<DomainMonitorDto> UpdateDomainMonitorWithHttpInfo(Guid monitorId, UpdateDomainMonitorOptions updateDomainMonitorOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| UpdateDomainMonitorOptions | updateDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<DomainMonitorDto> | ApiResponse of DomainMonitorDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
UpdateDomainMonitorWithHttpInfoAsync(Guid, UpdateDomainMonitorOptions, int, CancellationToken)
Update domain monitor
Declaration
public Task<ApiResponse<DomainMonitorDto>> UpdateDomainMonitorWithHttpInfoAsync(Guid monitorId, UpdateDomainMonitorOptions updateDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | monitorId | |
| UpdateDomainMonitorOptions | updateDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<DomainMonitorDto>> | Task of ApiResponse (DomainMonitorDto) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |