Interface ICameraQualityAndRetentionProfiles

Namespace

Meraki.Api.Interfaces.Products.Camera

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface ICameraQualityAndRetentionProfiles

Methods

CreateNetworkCameraQualityRetentionProfileAsync(string, CameraQualityRetentionProfileCreateUpdateRequest, CancellationToken)

Creates new quality retention profile for this network.

[Post("/networks/{networkId}/camera/qualityRetentionProfiles")]
Task<CameraQualityRetentionProfile> CreateNetworkCameraQualityRetentionProfileAsync(string networkId, CameraQualityRetentionProfileCreateUpdateRequest createNetworkCameraQualityRetentionProfile, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkCameraQualityRetentionProfile CameraQualityRetentionProfileCreateUpdateRequest

Body for creating quality retention profile

cancellationToken CancellationToken

Returns

Task<CameraQualityRetentionProfile>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkCameraQualityRetentionProfileAsync(string, string, CancellationToken)

Delete an existing quality retention profile for this network.

[Delete("/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}")]
Task DeleteNetworkCameraQualityRetentionProfileAsync(string networkId, string qualityRetentionProfileId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

qualityRetentionProfileId string

The quality retention profile id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkCameraQualityRetentionProfileAsync(string, string, CancellationToken)

Retrieve a single quality retention profile

[Get("/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}")]
Task<CameraQualityRetentionProfile> GetNetworkCameraQualityRetentionProfileAsync(string networkId, string qualityRetentionProfileId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

qualityRetentionProfileId string

The quality retention profile id

cancellationToken CancellationToken

Returns

Task<CameraQualityRetentionProfile>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkCameraQualityRetentionProfilesAsync(string, CancellationToken)

List the quality retention profiles for this network

[Get("/networks/{networkId}/camera/qualityRetentionProfiles")]
Task<List<CameraQualityRetentionProfile>> GetNetworkCameraQualityRetentionProfilesAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<CameraQualityRetentionProfile>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkCameraQualityRetentionProfileAsync(string, string, CameraQualityRetentionProfileCreateUpdateRequest, CancellationToken)

Update an existing quality retention profile for this network.

[Put("/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}")]
Task<CameraQualityRetentionProfile> UpdateNetworkCameraQualityRetentionProfileAsync(string networkId, string qualityRetentionProfileId, CameraQualityRetentionProfileCreateUpdateRequest updateNetworkCameraQualityRetentionProfile, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

qualityRetentionProfileId string

The quality retention profile id

updateNetworkCameraQualityRetentionProfile CameraQualityRetentionProfileCreateUpdateRequest

Body for updating quality retention profile

cancellationToken CancellationToken

Returns

Task<CameraQualityRetentionProfile>

Exceptions

ApiException

Thrown when fails to make API call