Interface IOrganizationsDevicesPacketCapture

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

I Organizations Devices Packet Capture

public interface IOrganizationsDevicesPacketCapture

Methods

BulkOrganizationDevicesPacketCaptureCapturesCreateAsync(string, List<OrganizationDevicesPacketCaptureCapturesBulkCreateRequest>, CancellationToken)

Perform a packet capture on multiple devices and store in Meraki Cloud.

[Post("/organizations/{organizationId}/devices/packetCapture/captures/bulkCreate")]
Task<OrganizationDevicesPacketCaptureCapturesBulkCreateResponse> BulkOrganizationDevicesPacketCaptureCapturesCreateAsync(string organizationId, List<OrganizationDevicesPacketCaptureCapturesBulkCreateRequest> request, CancellationToken cancellationToken = default)

Parameters

organizationId string

request List<OrganizationDevicesPacketCaptureCapturesBulkCreateRequest>

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureCapturesBulkCreateResponse>

Exceptions

ApiException

Thrown when fails to make API call

BulkOrganizationDevicesPacketCaptureCapturesDeleteAsync(string, OrganizationDevicesPacketCaptureCapturesBulkDeleteRequest, CancellationToken)

BulkDelete packet captures from cloud

[Post("/organizations/{organizationId}/devices/packetCapture/captures/bulkDelete")]
Task BulkOrganizationDevicesPacketCaptureCapturesDeleteAsync(string organizationId, OrganizationDevicesPacketCaptureCapturesBulkDeleteRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

request OrganizationDevicesPacketCaptureCapturesBulkDeleteRequest

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

BulkOrganizationDevicesPacketCaptureSchedulesDeleteAsync(string, OrganizationDevicesPacketCaptureSchedulesBulkDeleteRequest, CancellationToken)

Delete packet capture schedules

[Post("/organizations/{organizationId}/devices/packetCapture/schedules/bulkDelete")]
Task BulkOrganizationDevicesPacketCaptureSchedulesDeleteAsync(string organizationId, OrganizationDevicesPacketCaptureSchedulesBulkDeleteRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

request OrganizationDevicesPacketCaptureSchedulesBulkDeleteRequest

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

CreateOrganizationDevicesPacketCaptureCaptureAsync(string, OrganizationDevicesPacketCaptureCapturesCreateRequest, CancellationToken)

Perform a packet capture on a device and store in Meraki Cloud. Only a single switch may be chosen per request, while multiple access points are allowed at once.

[Post("/organizations/{organizationId}/devices/packetCapture/captures")]
Task<OrganizationDevicesPacketCaptureFile> CreateOrganizationDevicesPacketCaptureCaptureAsync(string organizationId, OrganizationDevicesPacketCaptureCapturesCreateRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

request OrganizationDevicesPacketCaptureCapturesCreateRequest

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureFile>

Exceptions

ApiException

Thrown when fails to make API call

CreateOrganizationDevicesPacketCaptureScheduleAsync(string, OrganizationDevicesPacketCaptureScheduleCreateRequest, CancellationToken)

Create a schedule for packet capture

[Post("/organizations/{organizationId}/devices/packetCapture/schedules")]
Task<OrganizationDevicesPacketCaptureSchedule> CreateOrganizationDevicesPacketCaptureScheduleAsync(string organizationId, OrganizationDevicesPacketCaptureScheduleCreateRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

request OrganizationDevicesPacketCaptureScheduleCreateRequest

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureSchedule>

Exceptions

ApiException

Thrown when fails to make API call

CreateOrganizationDevicesPacketCaptureTaskAsync(string, string, OrganizationDevicesPacketCaptureTaskCreateRequest, CancellationToken)

Enqueues a task for a specific packet capture. This endpoint has a sustained rate limit of one request every 60 seconds.

[Post("/organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks")]
Task<OrganizationDevicesPacketCaptureTask> CreateOrganizationDevicesPacketCaptureTaskAsync(string organizationId, string packetId, OrganizationDevicesPacketCaptureTaskCreateRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

packetId string

request OrganizationDevicesPacketCaptureTaskCreateRequest

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureTask>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationDevicesPacketCaptureCaptureAsync(string, string, CancellationToken)

Delete a single packet capture from cloud using captureId

[Delete("/organizations/{organizationId}/devices/packetCapture/captures/{captureId}")]
Task DeleteOrganizationDevicesPacketCaptureCaptureAsync(string organizationId, string captureId, CancellationToken cancellationToken = default)

Parameters

organizationId string

captureId string

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationDevicesPacketCaptureScheduleAsync(string, string, OrganizationDevicesPacketCaptureScheduleDeleteRequest, CancellationToken)

Delete schedule from cloud

[Delete("/organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}")]
Task DeleteOrganizationDevicesPacketCaptureScheduleAsync(string organizationId, string scheduleId, OrganizationDevicesPacketCaptureScheduleDeleteRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

scheduleId string

request OrganizationDevicesPacketCaptureScheduleDeleteRequest

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GenerateOrganizationDevicesPacketCaptureCaptureDownloadUrlAsync(string, string, CancellationToken)

Get presigned download URL for given packet capture id

[Post("/organizations/{organizationId}/devices/packetCapture/captures/{captureId}/downloadUrl/generate")]
Task<OrganizationDevicesPacketCaptureCaptureDownloadUrl> GenerateOrganizationDevicesPacketCaptureCaptureDownloadUrlAsync(string organizationId, string captureId, CancellationToken cancellationToken = default)

Parameters

organizationId string

captureId string

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureCaptureDownloadUrl>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationDevicesPacketCaptureCapturesAsync(string, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, string?, string?, string?, string?, string?, long?, int?, string?, string?, string?, CancellationToken)

List Packet Captures

[Get("/organizations/{organizationId}/devices/packetCapture/captures")]
Task<OrganizationDevicesPacketCaptureCapturesResponse> GetOrganizationDevicesPacketCaptureCapturesAsync(string organizationId, List<string>? captureIds = null, List<string>? networkIds = null, List<string>? serials = null, List<string>? process = null, List<string>? captureStatus = null, List<string>? name = null, List<string>? clientMac = null, string? notes = null, string? deviceName = null, string? adminName = null, string? t0 = null, string? t1 = null, long? timespan = null, int? perPage = 10, string? startingAfter = null, string? endingBefore = null, string? sortOrder = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

captureIds List<string>

Return the packet captures of the specified capture ids

networkIds List<string>

Return the packet captures of the specified network(s)

serials List<string>

Return the packet captures of the specified device(s)

process List<string>

Return the packet captures of the specified process

captureStatus List<string>

Return the packet captures of the specified capture status

name List<string>

Return the packet captures matching the specified name

clientMac List<string>

Return the packet captures matching the specified client macs

notes string

Return the packet captures matching the specified notes

deviceName string

Return the packet captures matching the specified device name

adminName string

Return the packet captures matching the admin name

t0 string

The beginning of the timespan for the data. The maximum lookback period is 365 days from today.

t1 string

The end of the timespan for the data. t1 can be a maximum of 365 days after t0.

timespan long?

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 365 days.maximum = 31536000

perPage int?

The number of entries per page returned. Acceptable range is 3 - 100. Default is 10.

startingAfter string

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

endingBefore string

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

sortOrder string

Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'descending'. enum = ["ascending", "descending"]

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureCapturesResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationDevicesPacketCaptureSchedulesAsync(string, CancellationToken)

List the Packet Capture Schedules

[Get("/organizations/{organizationId}/devices/packetCapture/schedules")]
Task<OrganizationDevicesPacketCaptureSchedulesResponse> GetOrganizationDevicesPacketCaptureSchedulesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureSchedulesResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationDevicesPacketCaptureTaskAsync(string, string, string, CancellationToken)

Retrieves packet capture analysis result for a specific packet capture task.

[Get("/organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks/{id}")]
Task<OrganizationDevicesPacketCaptureTaskDetailed> GetOrganizationDevicesPacketCaptureTaskAsync(string organizationId, string packetId, string id, CancellationToken cancellationToken = default)

Parameters

organizationId string

packetId string

id string

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureTaskDetailed>

Exceptions

ApiException

Thrown when fails to make API call

ReorderOrganizationDevicesPacketCaptureSchedulesAsync(string, OrganizationDevicesPacketCaptureSchedulesReorderRequest, CancellationToken)

Bulk update priorities of pcap schedules

[Post("/organizations/{organizationId}/devices/packetCapture/schedules/reorder")]
Task<OrganizationDevicesPacketCaptureSchedulesReorderResponse> ReorderOrganizationDevicesPacketCaptureSchedulesAsync(string organizationId, OrganizationDevicesPacketCaptureSchedulesReorderRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

request OrganizationDevicesPacketCaptureSchedulesReorderRequest

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureSchedulesReorderResponse>

Exceptions

ApiException

Thrown when fails to make API call

StopOrganizationDevicesPacketCaptureCaptureAsync(string, string, OrganizationDevicesPacketCaptureCapturesStopRequest, CancellationToken)

Stop a specific packet capture (not supported for Catalyst devices)

[Post("/organizations/{organizationId}/devices/packetCapture/captures/{captureId}/stop")]
Task<OrganizationDevicesPacketCaptureFile> StopOrganizationDevicesPacketCaptureCaptureAsync(string organizationId, string captureId, OrganizationDevicesPacketCaptureCapturesStopRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

captureId string

request OrganizationDevicesPacketCaptureCapturesStopRequest

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureFile>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationDevicesPacketCaptureScheduleAsync(string, string, OrganizationDevicesPacketCaptureScheduleUpdateRequest, CancellationToken)

Update a schedule for packet capture

[Put("/organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}")]
Task<OrganizationDevicesPacketCaptureSchedule> UpdateOrganizationDevicesPacketCaptureScheduleAsync(string organizationId, string scheduleId, OrganizationDevicesPacketCaptureScheduleUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

scheduleId string

request OrganizationDevicesPacketCaptureScheduleUpdateRequest

cancellationToken CancellationToken

Returns

Task<OrganizationDevicesPacketCaptureSchedule>

Exceptions

ApiException

Thrown when fails to make API call