List cloud exports.

Prev Next
Get
/cloud_export/v202506/exports

Returns a list of all cloud exports in the account.

Security
email & token
API Key: email
Header parameter nameX-CH-Auth-Email

API Key: token
Header parameter nameX-CH-Auth-API-Token
Responses
200

A successful response.

Expand All
object
exports
Array of object (v202506CloudExport)

List of cloud export objects.

object
id
string

Unique identifier of the instance

type
string
  • CLOUD_EXPORT_TYPE_UNSPECIFIED: Invalid value.
  • CLOUD_EXPORT_TYPE_KENTIK_MANAGED: Cloud export process is managed by Kentik
  • CLOUD_EXPORT_TYPE_CUSTOMER_MANAGED: Cloud export process is managed by customer
Valid values[ "CLOUD_EXPORT_TYPE_UNSPECIFIED", "CLOUD_EXPORT_TYPE_KENTIK_MANAGED", "CLOUD_EXPORT_TYPE_CUSTOMER_MANAGED" ]
Default"CLOUD_EXPORT_TYPE_UNSPECIFIED"
enabled
boolean

Attribute controlling whether the instance is active

name
string

User selected name of the instance

description
string

Description of the instance

planId
string

Identifier of the billing plan for the instance

cloudProvider
string
  • CLOUD_PROVIDER_UNSPECIFIED: Invalid value.
  • CLOUD_PROVIDER_AWS: Amazon Web Services
  • CLOUD_PROVIDER_AZURE: Microsoft Azure
  • CLOUD_PROVIDER_GCE: Google Cloud
  • CLOUD_PROVIDER_OCI: OCI
Valid values[ "CLOUD_PROVIDER_UNSPECIFIED", "CLOUD_PROVIDER_AWS", "CLOUD_PROVIDER_AZURE", "CLOUD_PROVIDER_GCE", "CLOUD_PROVIDER_OCI" ]
Default"CLOUD_PROVIDER_UNSPECIFIED"
aws
object (v202506AwsProperties)
iamRoleArn
string

ARN of the IAM role granted access to the S3 bucket and describe API end-points.

region
string

Name of AWS region from which to export flow logs.

metadataOnly
boolean

Import only metadata without any flows (default false).

collectFlowLogs
boolean

Import metadata and collect flow logs (default true).

collectFirewallLogs
boolean

Import metadata and collect firewall logs in addition to flow logs (default false). Note that in order to collect firewall logs without collection of flow logs, collect_flow_logs must be set to false.

collectMetrics
boolean

Import metadata and collect metrics data. Note that flow logs will still be collected unless metadata_only is also set to true. (default false).

bucket
string

Name of S3 bucket from which flow and/or firewall logs are to be exported.

bucketPrefix
string

Prefix of S3 bucket from which flow and/or firewall logs are to be exported.

deleteAfterRead
boolean

Delete from logs from the S3 bucket after export (default false).

awsIamRoleArnIsOrg
boolean

Iam role is organization role (default false).

secondaryAwsAccounts
Array of string

Accounts ids granted access to the describe API end-points.

string
secondaryAwsBlockedAccounts
Array of string

Accounts ids that should be filtered from organization when running describe API end-points.

string
secondaryAwsRegions
Array of string

Regions of secondary accounts from which to collect metadata.

string
secondaryAwsSuffix
string

Used to generate secondary account ARN based on template arn:aws:iam::<<aws_account_id>>:role/<<role_suffix>>

azure
object (v202506AzureProperties)
location
string

Azure region/location from which to export flow logs.

resourceGroup
string

Resource group containing the NSG generating flow logs.

storageAccount
string

Storage account from which flow logs are to be extracted.

subscriptionId
string

ID of Azure account from which flows logs are to be exported.

securityPrincipalEnabled
boolean

Indication whether security principal for the Kentik flow export application has been authorized.

gce
object (v202506GceProperties)
project
string

Name of the project from which to export flow logs.

subscription
string

GCP Pub/Sub subscription providing flow logs.

metadataOnly
boolean

Import only metadata without any flows (default false).

collectFlowLogs
boolean

Import metadata and collect flow logs (default true).

collectMetrics
boolean

Import metadata and collect metrics data. Note that flow logs will still be collected unless metadata_only is also set to true. (default false).

oci
object (v202506OciProperties)
ociUserId
string

ID of the user created to represent the Kentik cloud export tool.

ociTenancyId
string

OCI Tenancy details.

ociCompartmentId
Array of string

Compartment IDs from which to collect metadata.

string
ociDefaultRegion
string

Default Enabled Region from which to collect metadata.

ociCollectFlowLogs
boolean

Import metadata and collect flow logs (default true).

ociBucketName
string

Name of the bucket from which flow logs are to be extracted. Required if collecting flow logs (default)

ociBucketNamespaceName
string

Namespace of the bucket from which flow logs are to be extracted. Required if collecting flow logs (default)

ociServiceConnectorOcid
string
ociFlowObjectNamePrefix
string

We will look for files in the bucket whose names start with {%prefix%}/{%service_connector_ocid%}

metadataOnly
boolean

Import only metadata without any flows (default false).

currentStatus
object (v202506CloudExportStatus)
status
string

Status of the export task.

errorMessage
string

Text of the last error message (empty if status is OK).

flowFound
boolean

Indication whether any flow data were exported.

apiAccess
boolean

Indication whether the export process is able to access cloud API.

storageAccountAccess
boolean

Indication whether the export process is able to access storage account containing flow logs.

cdate
string (date-time)

Creation timestamp (UTC)

edate
string (date-time)

Last modification timestamp (UTC)

sampling
object (v202506CloudExportSamplingProperties)
samplingEnabled
boolean

Boolean indicating if sampling is used for this export.

samplingType
string
Valid values[ "CLOUD_EXPORT_SAMPLING_TYPE_UNSPECIFIED", "CLOUD_EXPORT_SAMPLING_TYPE_RATE", "CLOUD_EXPORT_SAMPLING_TYPE_UNSAMPLED" ]
Default"CLOUD_EXPORT_SAMPLING_TYPE_UNSPECIFIED"
samplingRate
integer (int64)

Sampling rate for the export.

invalidExportsCount
integer (int64)

Number of objects with invalid data (which are not returned in the response).

default

An unexpected error response.

Expand All
object
code
integer (int32)
message
string
details
Array of object (protobufAny)
object
typeUrl
string
value
string (byte)