Skip to content

MagicPCAPCollectionApi.md

Latest commit

 

History

History
492 lines (352 loc) · 20 KB

MagicPCAPCollectionApi.md

File metadata and controls

492 lines (352 loc) · 20 KB

cloudflare_dart.api.MagicPCAPCollectionApi

Load the API package

import 'package:cloudflare_dart/api.dart';

All URIs are relative to https://api.cloudflare.com/client/v4

Method HTTP request Description
magicPcapCollectionAddBucketsForFullPacketCaptures POST /accounts/{account_id}/pcaps/ownership Add buckets for full packet captures
magicPcapCollectionCreatePcapRequest POST /accounts/{account_id}/pcaps Create PCAP request
magicPcapCollectionDeleteBucketsForFullPacketCaptures DELETE /accounts/{account_id}/pcaps/ownership/{ownership_id} Delete buckets for full packet captures
magicPcapCollectionDownloadSimplePcap GET /accounts/{account_id}/pcaps/{pcap_id}/download Download Simple PCAP
magicPcapCollectionGetPcapRequest GET /accounts/{account_id}/pcaps/{pcap_id} Get PCAP request
magicPcapCollectionListPacketCaptureRequests GET /accounts/{account_id}/pcaps List packet capture requests
magicPcapCollectionListPcaPsBucketOwnership GET /accounts/{account_id}/pcaps/ownership List PCAPs Bucket Ownership
magicPcapCollectionStopFullPcap PUT /accounts/{account_id}/pcaps/{pcap_id}/stop Stop full PCAP
magicPcapCollectionValidateBucketsForFullPacketCaptures POST /accounts/{account_id}/pcaps/ownership/validate Validate buckets for full packet captures

magicPcapCollectionAddBucketsForFullPacketCaptures

MagicVisibilityPcapsPcapsOwnershipSingleResponse magicPcapCollectionAddBucketsForFullPacketCaptures(accountId, magicVisibilityPcapsPcapsOwnershipRequest)

Add buckets for full packet captures

Adds an AWS or GCP bucket to use with full packet captures.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getMagicPCAPCollectionApi();
final String accountId = accountId_example; // String | 
final MagicVisibilityPcapsPcapsOwnershipRequest magicVisibilityPcapsPcapsOwnershipRequest = ; // MagicVisibilityPcapsPcapsOwnershipRequest | 

try {
    final response = api.magicPcapCollectionAddBucketsForFullPacketCaptures(accountId, magicVisibilityPcapsPcapsOwnershipRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling MagicPCAPCollectionApi->magicPcapCollectionAddBucketsForFullPacketCaptures: $e\n');
}

Parameters

Name Type Description Notes
accountId String
magicVisibilityPcapsPcapsOwnershipRequest MagicVisibilityPcapsPcapsOwnershipRequest

Return type

MagicVisibilityPcapsPcapsOwnershipSingleResponse

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

magicPcapCollectionCreatePcapRequest

MagicVisibilityPcapsPcapsSingleResponse magicPcapCollectionCreatePcapRequest(accountId, magicVisibilityPcapsPcapsRequestPcap)

Create PCAP request

Create new PCAP request for account.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getMagicPCAPCollectionApi();
final String accountId = accountId_example; // String | 
final MagicVisibilityPcapsPcapsRequestPcap magicVisibilityPcapsPcapsRequestPcap = ; // MagicVisibilityPcapsPcapsRequestPcap | 

try {
    final response = api.magicPcapCollectionCreatePcapRequest(accountId, magicVisibilityPcapsPcapsRequestPcap);
    print(response);
} catch on DioException (e) {
    print('Exception when calling MagicPCAPCollectionApi->magicPcapCollectionCreatePcapRequest: $e\n');
}

Parameters

Name Type Description Notes
accountId String
magicVisibilityPcapsPcapsRequestPcap MagicVisibilityPcapsPcapsRequestPcap

Return type

MagicVisibilityPcapsPcapsSingleResponse

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

magicPcapCollectionDeleteBucketsForFullPacketCaptures

magicPcapCollectionDeleteBucketsForFullPacketCaptures(ownershipId, accountId)

Delete buckets for full packet captures

Deletes buckets added to the packet captures API.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getMagicPCAPCollectionApi();
final String ownershipId = ownershipId_example; // String | 
final String accountId = accountId_example; // String | 

try {
    api.magicPcapCollectionDeleteBucketsForFullPacketCaptures(ownershipId, accountId);
} catch on DioException (e) {
    print('Exception when calling MagicPCAPCollectionApi->magicPcapCollectionDeleteBucketsForFullPacketCaptures: $e\n');
}

Parameters

Name Type Description Notes
ownershipId String
accountId String

Return type

void (empty response body)

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

magicPcapCollectionDownloadSimplePcap

magicPcapCollectionDownloadSimplePcap(pcapId, accountId)

Download Simple PCAP

Download PCAP information into a file. Response is a binary PCAP file.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getMagicPCAPCollectionApi();
final String pcapId = pcapId_example; // String | 
final String accountId = accountId_example; // String | 

try {
    api.magicPcapCollectionDownloadSimplePcap(pcapId, accountId);
} catch on DioException (e) {
    print('Exception when calling MagicPCAPCollectionApi->magicPcapCollectionDownloadSimplePcap: $e\n');
}

Parameters

Name Type Description Notes
pcapId String
accountId String

Return type

void (empty response body)

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.tcpdump.pcap, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

magicPcapCollectionGetPcapRequest

MagicVisibilityPcapsPcapsSingleResponse magicPcapCollectionGetPcapRequest(pcapId, accountId)

Get PCAP request

Get information for a PCAP request by id.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getMagicPCAPCollectionApi();
final String pcapId = pcapId_example; // String | 
final String accountId = accountId_example; // String | 

try {
    final response = api.magicPcapCollectionGetPcapRequest(pcapId, accountId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling MagicPCAPCollectionApi->magicPcapCollectionGetPcapRequest: $e\n');
}

Parameters

Name Type Description Notes
pcapId String
accountId String

Return type

MagicVisibilityPcapsPcapsSingleResponse

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

magicPcapCollectionListPacketCaptureRequests

MagicVisibilityPcapsPcapsCollectionResponse magicPcapCollectionListPacketCaptureRequests(accountId)

List packet capture requests

Lists all packet capture requests for an account.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getMagicPCAPCollectionApi();
final String accountId = accountId_example; // String | 

try {
    final response = api.magicPcapCollectionListPacketCaptureRequests(accountId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling MagicPCAPCollectionApi->magicPcapCollectionListPacketCaptureRequests: $e\n');
}

Parameters

Name Type Description Notes
accountId String

Return type

MagicVisibilityPcapsPcapsCollectionResponse

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

magicPcapCollectionListPcaPsBucketOwnership

MagicVisibilityPcapsPcapsOwnershipCollection magicPcapCollectionListPcaPsBucketOwnership(accountId)

List PCAPs Bucket Ownership

List all buckets configured for use with PCAPs API.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getMagicPCAPCollectionApi();
final String accountId = accountId_example; // String | 

try {
    final response = api.magicPcapCollectionListPcaPsBucketOwnership(accountId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling MagicPCAPCollectionApi->magicPcapCollectionListPcaPsBucketOwnership: $e\n');
}

Parameters

Name Type Description Notes
accountId String

Return type

MagicVisibilityPcapsPcapsOwnershipCollection

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

magicPcapCollectionStopFullPcap

magicPcapCollectionStopFullPcap(pcapId, accountId)

Stop full PCAP

Stop full PCAP.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getMagicPCAPCollectionApi();
final String pcapId = pcapId_example; // String | 
final String accountId = accountId_example; // String | 

try {
    api.magicPcapCollectionStopFullPcap(pcapId, accountId);
} catch on DioException (e) {
    print('Exception when calling MagicPCAPCollectionApi->magicPcapCollectionStopFullPcap: $e\n');
}

Parameters

Name Type Description Notes
pcapId String
accountId String

Return type

void (empty response body)

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

magicPcapCollectionValidateBucketsForFullPacketCaptures

MagicVisibilityPcapsPcapsOwnershipSingleResponse magicPcapCollectionValidateBucketsForFullPacketCaptures(accountId, magicVisibilityPcapsPcapsOwnershipValidateRequest)

Validate buckets for full packet captures

Validates buckets added to the packet captures API.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getMagicPCAPCollectionApi();
final String accountId = accountId_example; // String | 
final MagicVisibilityPcapsPcapsOwnershipValidateRequest magicVisibilityPcapsPcapsOwnershipValidateRequest = ; // MagicVisibilityPcapsPcapsOwnershipValidateRequest | 

try {
    final response = api.magicPcapCollectionValidateBucketsForFullPacketCaptures(accountId, magicVisibilityPcapsPcapsOwnershipValidateRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling MagicPCAPCollectionApi->magicPcapCollectionValidateBucketsForFullPacketCaptures: $e\n');
}

Parameters

Name Type Description Notes
accountId String
magicVisibilityPcapsPcapsOwnershipValidateRequest MagicVisibilityPcapsPcapsOwnershipValidateRequest

Return type

MagicVisibilityPcapsPcapsOwnershipSingleResponse

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]