Interface IDomainMonitorControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IDomainMonitorControllerApiSync : IApiAccessor

Methods

View Source

CreateDomainMonitor(CreateDomainMonitorOptions, int)

Create domain monitor

Declaration
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
View Source

CreateDomainMonitorAlertSink(Guid, CreateDomainMonitorAlertSinkOptions, int)

Create alert sink for monitor

Declaration
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
View Source

CreateDomainMonitorAlertSinkWithHttpInfo(Guid, CreateDomainMonitorAlertSinkOptions, int)

Create alert sink for monitor

Declaration
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
View Source

CreateDomainMonitorWithHttpInfo(CreateDomainMonitorOptions, int)

Create domain monitor

Declaration
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
View Source

DeleteDomainMonitor(Guid, int)

Delete domain monitor

Declaration
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
View Source

DeleteDomainMonitorAlertSink(Guid, Guid, int)

Delete monitor alert sink

Declaration
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
View Source

DeleteDomainMonitorAlertSinkWithHttpInfo(Guid, Guid, int)

Delete monitor alert sink

Declaration
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
View Source

DeleteDomainMonitorWithHttpInfo(Guid, int)

Delete domain monitor

Declaration
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
View Source

GetDomainMonitor(Guid, int)

Get domain monitor

Declaration
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
View Source

GetDomainMonitorAlertSinks(Guid, int)

List alert sinks for monitor

Declaration
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
View Source

GetDomainMonitorAlertSinksWithHttpInfo(Guid, int)

List alert sinks for monitor

Declaration
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
View Source

GetDomainMonitorInsights(Guid, DateTime?, DateTime?, int)

Get monitor insights

Declaration
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
View Source

GetDomainMonitorInsightsWithHttpInfo(Guid, DateTime?, DateTime?, int)

Get monitor insights

Declaration
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
View Source

GetDomainMonitorRuns(Guid, DateTime?, DateTime?, string, int?, int)

List monitor runs

Declaration
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
View Source

GetDomainMonitorRunsWithHttpInfo(Guid, DateTime?, DateTime?, string, int?, int)

List monitor runs

Declaration
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
View Source

GetDomainMonitorSeries(Guid, DateTime?, DateTime?, string, int)

Get monitor trend series

Declaration
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
View Source

GetDomainMonitorSeriesWithHttpInfo(Guid, DateTime?, DateTime?, string, int)

Get monitor trend series

Declaration
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
View Source

GetDomainMonitorWithHttpInfo(Guid, int)

Get domain monitor

Declaration
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
View Source

GetDomainMonitors(int)

List domain monitors

Declaration
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
View Source

GetDomainMonitorsWithHttpInfo(int)

List domain monitors

Declaration
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
View Source

RunDomainMonitorNow(Guid, int)

Run monitor now

Declaration
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
View Source

RunDomainMonitorNowWithHttpInfo(Guid, int)

Run monitor now

Declaration
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
View Source

RunDueDomainMonitors(int?, int)

Run due monitors for user

Declaration
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
View Source

RunDueDomainMonitorsWithHttpInfo(int?, int)

Run due monitors for user

Declaration
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
View Source

UpdateDomainMonitor(Guid, UpdateDomainMonitorOptions, int)

Update domain monitor

Declaration
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
View Source

UpdateDomainMonitorWithHttpInfo(Guid, UpdateDomainMonitorOptions, int)

Update domain monitor

Declaration
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