Interface IInsightMonitoredMediaServers

Namespace

Meraki.Api.Interfaces.Products.Insight

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IInsightMonitoredMediaServers

Methods

CreateOrganizationInsightMonitoredMediaServerAsync(string, InsightMonitoredMediaServerCreationRequest, CancellationToken)

Add a media server to be monitored for this organization

[Post("/organizations/{organizationId}/insight/monitoredMediaServers")]
Task<InsightMonitoredMediaServer> CreateOrganizationInsightMonitoredMediaServerAsync(string organizationId, InsightMonitoredMediaServerCreationRequest createOrganizationInsightMonitoredMediaServer, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

createOrganizationInsightMonitoredMediaServer InsightMonitoredMediaServerCreationRequest

Body for adding a media server

cancellationToken CancellationToken

Returns

Task<InsightMonitoredMediaServer>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationInsightMonitoredMediaServerAsync(string, string, CancellationToken)

Delete a monitored media server from this organization

[Delete("/organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}")]
Task DeleteOrganizationInsightMonitoredMediaServerAsync(string organizationId, string monitoredMediaServerId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

monitoredMediaServerId string

The monitored media server id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationInsightMonitoredMediaServerAsync(string, string, CancellationToken)

Return a monitored media server for this organization

[Get("/organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}")]
Task<InsightMonitoredMediaServer> GetOrganizationInsightMonitoredMediaServerAsync(string organizationId, string monitoredMediaServerId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

monitoredMediaServerId string

The monitored media server id

cancellationToken CancellationToken

Returns

Task<InsightMonitoredMediaServer>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationInsightMonitoredMediaServersAsync(string, CancellationToken)

List the monitored media servers for this organization

[Get("/organizations/{organizationId}/insight/monitoredMediaServers")]
Task<List<InsightMonitoredMediaServer>> GetOrganizationInsightMonitoredMediaServersAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<List<InsightMonitoredMediaServer>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationInsightMonitoredMediaServerAsync(string, string, InsightMonitoredMediaServerUpdateRequest, CancellationToken)

Update a monitored media server for this organization

[Put("/organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}")]
Task<InsightMonitoredMediaServer> UpdateOrganizationInsightMonitoredMediaServerAsync(string organizationId, string monitoredMediaServerId, InsightMonitoredMediaServerUpdateRequest updateOrganizationInsightMonitoredMediaServer, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

monitoredMediaServerId string

The monitored media server id

updateOrganizationInsightMonitoredMediaServer InsightMonitoredMediaServerUpdateRequest

Body for updating a monitored media server

cancellationToken CancellationToken

Returns

Task<InsightMonitoredMediaServer>

Exceptions

ApiException

Thrown when fails to make API call