Netography Traffic Sources - VPCs API
The Traffic Sources - VPCs API from Netography — 8 operation(s) for traffic sources - vpcs.
OpenAPI Specification
openapi: 3.0.0
info:
title: Netography (Vectra Fusion) Analytics Traffic Sources - VPCs API
version: '1.0'
description: Netography Fusion (now Vectra Fusion) REST API. Harvested from the provider's public API reference (docs.fusion.vectra.ai, formerly docs.netography.com).
x-apievangelist-source: https://docs.fusion.vectra.ai/api-reference (formerly docs.netography.com); harvested from embedded OpenAPI blocks
x-apievangelist-method: searched
x-apievangelist-generated: '2026-07-20'
servers:
- url: https://api.netography.com
description: Netography API
tags:
- name: Traffic Sources - VPCs
paths:
/api/v1/vpc:
get:
operationId: v1_vpc_get
summary: List All VPCs
description: 'Return a list of all Cloud Sources. Supports filtering by flowtype, flowresource, traffictype, and logtype (all together or separate).
'
tags:
- Traffic Sources - VPCs
parameters:
- name: flowtype
in: query
description: Filter by flow type (e.g., aws, azure, gcp, etc.)
required: false
schema:
type: string
- name: flowresource
in: query
description: Filter by flow resource (e.g., s3, kinesis, etc.)
required: false
schema:
type: string
- name: traffictype
in: query
description: Filter by traffic type (e.g., dns, flow)
required: false
schema:
type: string
- name: logtype
in: query
description: Filter by log type (e.g., gcp-dns-query-log, etc.)
required: false
schema:
type: string
responses:
'200':
description: List of VPCs Requested
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
meta:
type: object
additionalProperties: false
readOnly: true
properties:
code:
description: API response code. 200 ok, 400 you did something wrong. 500 we did something wrong
type: integer
readOnly: true
format: int32
count:
description: Number of documents retrieved or updated.
type: integer
readOnly: true
format: int32
data:
description: Result set from API call
type: array
maxItems: 1000
items:
additionalProperties: false
properties:
id:
description: VPC id
readOnly: true
type: string
oneOf:
- description: AWS Kinesis Parameters.
type: object
required:
- flowtype
- flowresource
- name
- enabled
- samplerate
- region
- shardid
- stream
- awsauthtype
additionalProperties: false
properties:
flowtype:
description: The VPC's flowtype
type: string
enum:
- aws
flowresource:
description: The VPC's resource used to transmit flow events.
type: string
enum:
- kinesis
traffictype:
description: The VPC's traffic type. Can't be changed at updating.
type: string
enum:
- flow
name:
description: The name of the VPC. Eg. prod-vpc-east
type: string
enabled:
description: If this VPC is enabled or disabled.
type: boolean
samplerate:
description: The samplerate of flows this VPC will send. Between 1 and 65535.
type: integer
format: int32
minimum: 1
maximum: 65535
region:
type: string
description: 'The region the VPC is in. See <a href="/netography-docs/reference/get_api-v1-vpc-regions-flowtype">Get VPC regions by flowtype</a> for a list of valid regions.
'
shardid:
type: string
description: Kinesis shard id
stream:
description: Kinesis stream
type: string
tags:
description: An array of strings to tag every flow from this VPC with.
type: array
items:
type: string
awsauthtype:
description: '<p>The method of authentication to use with AWS. Valid options are:</p> <ul> <li><code>AccessKey</code>: indicates key/secret auth. <code>accesskeyid</code> and <code>accesssecret</code> fields are then required.</li> <li><code>RoleARN</code> indicates that role auth. The <code>role</code> object is then required.</li> </ul>
'
type: string
enum:
- AccessKey
- RoleARN
accesskeyid:
description: AWS accesskey id. Required for <code>AccessKey</code> auth type.
type: string
accesssecret:
description: AWS Access secret. Required for <code>AccessKey</code> auth type.
type: string
role:
description: object containing role authentication data. Required for <code>RoleARN</code> auth type.
type: object
properties:
arn:
description: ARN used to authenticate the flow source
type: string
- description: AWS S3 Parameters
type: object
required:
- flowtype
- flowresource
- name
- enabled
- samplerate
- bucket
- bucketregion
- region
- awsauthtype
properties:
flowtype:
description: The VPC's flowtype
type: string
enum:
- aws
flowresource:
description: The VPC's resource used to transmit flow events.
type: string
enum:
- s3
traffictype:
description: The VPC's traffic type. Can't be changed at updating.
type: string
enum:
- flow
- dns
name:
description: The name of the VPC. Eg. prod-vpc-east
type: string
enabled:
description: If this VPC is enabled or disabled.
type: boolean
samplerate:
description: The samplerate of flows this VPC will send. Between 1 and 65535.
type: integer
format: int32
minimum: 1
maximum: 65535
bucket:
type: string
description: S3 bucket
bucketregion:
type: string
description: Region this S3 bucket is in.
hive:
type: string
description: S3 Hive-compatible prefix
prefix:
type: string
description: S3 flow log path prefix
region:
type: string
description: 'The region the VPC is in. See <a href="/netography-docs/reference/get_api-v1-vpc-regions-flowtype">Get VPC regions by flowtype</a> for a list of valid regions.
'
sqsurl:
type: string
description: SQS URL of S3 events
tags:
description: An array of strings to tag every flow from this VPC with.
type: array
items:
type: string
awsauthtype:
description: '<p>The method of authentication to use with AWS. Valid options are:</p> <ul> <li><code>AccessKey</code>: indicates key/secret auth. <code>accesskeyid</code> and <code>accesssecret</code> fields are then required.</li> <li><code>RoleARN</code> indicates that role auth. The <code>role</code> object is then required.</li> </ul>
'
type: string
enum:
- AccessKey
- RoleARN
accesskeyid:
description: AWS accesskey id. Required for <code>AccessKey</code> auth type.
type: string
accesssecret:
description: AWS Access secret. Required for <code>AccessKey</code> auth type.
type: string
role:
description: object containing role authentication data. Required for <code>RoleARN</code> auth type.
type: object
properties:
arn:
description: ARN used to authenticate the flow source
type: string
vpcid:
description: VPC ID of the source, applicable and required only for dns traffictype
type: string
- description: Azure Blobstorage Parameters
type: object
required:
- flowtype
- flowresource
- name
- enabled
- samplerate
- region
- accountname
- accountkey
- containername
- networksecuritygroup
- resourcegroup
- subscriptionid
additionalProperties: false
properties:
flowtype:
description: The VPC's flowtype
type: string
enum:
- azure
flowresource:
description: The VPC's resource used to transmit flow events.
type: string
enum:
- blobstorage
traffictype:
description: The VPC's traffic type. Can't be changed at updating.
type: string
enum:
- flow
name:
description: The name of the VPC. Eg. prod-vpc-east
type: string
enabled:
description: If this VPC is enabled or disabled.
type: boolean
samplerate:
description: The samplerate of flows this VPC will send. Between 1 and 65535.
type: integer
format: int32
minimum: 1
maximum: 65535
region:
type: string
description: 'The region the VPC is in. See <a href="/netography-docs/reference/get_api-v1-vpc-regions-flowtype">Get VPC regions by flowtype</a> for a list of valid regions.
'
accountname:
type: string
description: Azure Storage Account's Access Name
accountkey:
type: string
description: Azure Storage Account's Access Key
containername:
type: string
description: Azure Storage Account's Container Name
networksecuritygroup:
type: string
description: Azure Network Security Group's Name
resourcegroup:
type: string
description: Azure Network Security Group's Resource Group
subscriptionid:
type: string
description: Azure Network Security Group's subscription ID
tags:
description: An array of strings to tag every flow from this VPC with.
type: array
items:
type: string
- description: GCP PubSub Parameters
type: object
required:
- flowtype
- flowresource
- name
- enabled
- samplerate
- projectid
- subid
additionalProperties: false
properties:
flowtype:
description: The VPC's flowtype
type: string
enum:
- gcp
flowresource:
description: The VPC's resource used to transmit flow events.
type: string
enum:
- pubsub
traffictype:
description: The VPC's traffic type. Can't be changed at updating.
type: string
enum:
- flow
- dns
name:
description: The name of the VPC. Eg. prod-vpc-east
type: string
enabled:
description: If this VPC is enabled or disabled.
type: boolean
samplerate:
description: The samplerate of flows this VPC will send. Between 1 and 65535.
type: integer
format: int32
minimum: 1
maximum: 65535
region:
type: string
description: 'The region the VPC is in. See <a href="/netography-docs/reference/get_api-v1-vpc-regions-flowtype">Get VPC regions by flowtype</a> for a list of valid regions.
'
projectid:
type: string
description: GCP Project ID
subid:
type: string
description: GCP PubSub Subscription ID
samplepercent:
description: Sample Rate Percent
type: integer
format: int32
minimum: 1
maximum: 100
tags:
description: An array of strings to tag every flow from this VPC with.
type: array
items:
type: string
- description: IBM Objectstorage Parameters
type: object
required:
- flowtype
- flowresource
- name
- enabled
- samplerate
- region
- apikey
- bucket
- serviceinstanceid
additionalProperties: false
properties:
flowtype:
description: The VPC's flowtype
type: string
enum:
- ibm
flowresource:
description: The VPC's resource used to transmit flow events.
type: string
enum:
- objectstorage
traffictype:
description: The VPC's traffic type. Can't be changed at updating.
type: string
enum:
- flow
name:
description: The name of the VPC. Eg. prod-vpc-east
type: string
enabled:
description: If this VPC is enabled or disabled.
type: boolean
samplerate:
description: The samplerate of flows this VPC will send. Between 1 and 65535.
type: integer
format: int32
minimum: 1
maximum: 65535
region:
type: string
description: 'The region the VPC is in. See <a href="/netography-docs/reference/get_api-v1-vpc-regions-flowtype">Get VPC regions by flowtype</a> for a list of valid regions.
'
apikey:
type: string
description: IBM Objectstorage API key that is associated for the Service ID.
bucket:
type: string
description: The Objectstorage bucket name.
prefix:
type: string
description: Flow log path prefix
serviceinstanceid:
type: string
description: Unique identifier for the instance of Object Storage the credential accesses. This is also referred to as a service credential.
tags:
description: An array of strings to tag every flow from this VPC with.
type: array
items:
type: string
- description: Oracle Objectstorage Parameters
type: object
required:
- flowtype
- flowresource
- name
- enabled
- samplerate
- region
- bucket
- tenancy
- userid
additionalProperties: false
properties:
flowtype:
description: The VPC's flowtype
type: string
enum:
- oracle
flowresource:
description: The VPC's resource used to transmit flow events.
type: string
enum:
- objectstorage
traffictype:
description: The VPC's traffic type. Can't be changed at updating.
type: string
enum:
- flow
name:
description: The name of the VPC. Eg. prod-vpc-east
type: string
enabled:
description: If this VPC is enabled or disabled.
type: boolean
samplerate:
description: The samplerate of flows this VPC will send. Between 1 and 65535.
type: integer
format: int32
minimum: 1
maximum: 65535
region:
type: string
description: 'The region the VPC is in. See <a href="/netography-docs/reference/get_api-v1-vpc-regions-flowtype">Get VPC regions by flowtype</a> for a list of valid regions.
'
bucket:
type: string
description: The Oracle Objectstorage bucket name.
tenancy:
type: string
description: Every Oracle Cloud Infrastructure resource has an Oracle-assigned unique ID called an Oracle Cloud Identifier (OCID).
userid:
type: string
description: Oracle assigns each user a unique ID called an Oracle Cloud ID (OCID).
prefix:
type: string
description: Optional folder prefix
tags:
description: An array of strings to tag every flow from this VPC with.
type: array
items:
type: string
'400':
description: Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.
content:
application/json:
schema:
allOf:
- type: object
required:
- status
- name
- message
additionalProperties: false
properties:
status:
description: "API response code: \n * 4xx - you did something dumb\n * 5xx - we did something dumb\n"
type: integer
readOnly: true
format: int32
name:
description: They type of error
type: string
readOnly: true
message:
description: description of the error
type: string
readOnly: true
- type: object
properties:
status: {}
name: {}
message: {}
'401':
description: Access token is missing or invalid
content:
application/json:
schema:
allOf:
- type: object
required:
- status
- name
- message
additionalProperties: false
properties:
status:
description: "API response code: \n * 4xx - you did something dumb\n * 5xx - we did something dumb\n"
type: integer
readOnly: true
format: int32
name:
description: They type of error
type: string
readOnly: true
message:
description: description of the error
type: string
readOnly: true
- type: object
properties:
status: {}
name: {}
message: {}
'403':
description: Access is forbidden
content:
application/json:
schema:
allOf:
- type: object
required:
- status
- name
- message
additionalProperties: false
properties:
status:
description: "API response code: \n * 4xx - you did something dumb\n * 5xx - we did something dumb\n"
type: integer
readOnly: true
format: int32
name:
description: They type of error
type: string
readOnly: true
message:
description: description of the error
type: string
readOnly: true
- type: object
properties:
status: {}
name: {}
message: {}
default:
description: Unknown Error Occurred
content:
application/json:
schema:
type: object
required:
- status
- name
- message
additionalProperties: false
properties:
status:
description: "API response code: \n * 4xx - you did something dumb\n * 5xx - we did something dumb\n"
type: integer
readOnly: true
format: int32
name:
description: They type of error
type: string
readOnly: true
message:
description: description of the error
type: string
readOnly: true
post:
operationId: v1_vpc_post
summary: Create VPC
description: Create a VPC from the supplied object. Do NOT submit an ID. IDs are auto generated and immutable.
requestBody:
description: VPC to be added
required: true
content:
application/json:
schema:
oneOf:
- description: AWS Kinesis Parameters.
type: object
required:
- flowtype
- flowresource
- name
- enabled
- samplerate
- region
- shardid
- stream
- awsauthtype
additionalProperties: false
properties:
flowtype:
description: The VPC's flowtype
type: string
enum:
- aws
flowresource:
description: The VPC's resource used to transmit flow events.
type: string
enum:
- kinesis
traffictype:
description: The VPC's traffic type. Can't be changed at updating.
type: string
enum:
- flow
name:
description: The name of the VPC. Eg. prod-vpc-east
type: string
enabled:
description: If this VPC is enabled or disabled.
type: boolean
samplerate:
description: The samplerate of flows this VPC will send. Between 1 and 65535.
type: integer
format: int32
minimum: 1
maximum: 65535
region:
type: string
description: 'The region the VPC is in. See <a href="/netography-docs/reference/get_api-v1-vpc-regions-flowtype">Get VPC regions by flowtype</a> for a list of valid regions.
'
shardid:
type: string
description: Kinesis shard id
stream:
description: Kinesis stream
type: string
tags:
description: An array of strings to tag every flow from this VPC with.
type: array
items:
type: string
awsauthtype:
description: '<p>The method of authentication to use with AWS. Valid options are:</p> <ul> <li><code>AccessKey</code>: indicates key/secret auth. <code>accesskeyid</code> and <code>accesssecret</code> fields are then required.</li> <li><code>RoleARN</code> indicates that role auth. The <code>role</code> object is then required.</li> </ul>
'
type: string
enum:
- AccessKey
- RoleARN
accesskeyid:
description: AWS accesskey id. Required for <code>AccessKey</code> auth type.
type: string
accesssecret:
description: AWS Access secret. Required for <code>AccessKey</code> auth type.
type: string
role:
description: object containing role authentication data. Required for <code>RoleARN</code> auth type.
type: object
properties:
arn:
description: ARN used to authenticate the flow source
type: string
- description: AWS S3 Parameters
type: object
required:
- flowtype
- flowresource
- name
- enabled
- samplerate
- bucket
- bucketregion
- region
- awsau
# --- truncated at 32 KB (239 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netography/refs/heads/main/openapi/netography-traffic-sources-vpcs-api-openapi.yml