Traffic Sources VPCs

List All VPCs

get

Return a list of all Cloud Sources. Supports filtering by flowtype, flowresource, traffictype, and logtype (all together or separate).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

flowtypestringOptional

Filter by flow type (e.g., aws, azure, gcp, etc.)

flowresourcestringOptional

Filter by flow resource (e.g., s3, kinesis, etc.)

traffictypestringOptional

Filter by traffic type (e.g., dns, flow)

logtypestringOptional

Filter by log type (e.g., gcp-dns-query-log, etc.)

Responses

200

List of VPCs Requested

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/vpc

GET /api/v1/vpc HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "flowtype": "aws",
      "flowresource": "kinesis",
      "traffictype": "flow",
      "name": "prod-us-east-1",
      "enabled": true,
      "samplerate": 1,
      "region": "us-east-1",
      "shardid": "shardId-000000000000",
      "stream": "flowlogstream",
      "tags": [
        "us-traffic",
        "prod-traffic"
      ],
      "awsauthtype": "AccessKey",
      "accesskeyid": "text",
      "accesssecret": "text",
      "role": {
        "arn": "arn:aws:iam::464179634201:role/Extension"
      }
    }
  ]
}

Create VPC

post

Create a VPC from the supplied object. Do NOT submit an ID. IDs are auto generated and immutable.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

anyOptional

Responses

201

List of VPCs Requested

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

post

/api/v1/vpc

POST /api/v1/vpc HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 361

{
  "flowtype": "aws",
  "flowresource": "kinesis",
  "traffictype": "flow",
  "name": "prod-us-east-1",
  "enabled": true,
  "samplerate": 1,
  "region": "us-east-1",
  "shardid": "shardId-000000000000",
  "stream": "flowlogstream",
  "tags": [
    "us-traffic",
    "prod-traffic"
  ],
  "awsauthtype": "AccessKey",
  "accesskeyid": "text",
  "accesssecret": "text",
  "role": {
    "arn": "arn:aws:iam::464179634201:role/Extension"
  }
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "flowtype": "aws",
      "flowresource": "kinesis",
      "traffictype": "flow",
      "name": "prod-us-east-1",
      "enabled": true,
      "samplerate": 1,
      "region": "us-east-1",
      "shardid": "shardId-000000000000",
      "stream": "flowlogstream",
      "tags": [
        "us-traffic",
        "prod-traffic"
      ],
      "awsauthtype": "AccessKey",
      "accesskeyid": "text",
      "accesssecret": "text",
      "role": {
        "arn": "arn:aws:iam::464179634201:role/Extension"
      }
    }
  ]
}

Get VPC by Name

get

Fetches a specific VPC by the name supplied in the path.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

The name of the VPC to fetch.

Responses

200

Object of a VPCs Requested

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/vpc/name/{name}

GET /api/v1/vpc/name/{name} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "id": "731612398",
    "flowtype": "aws",
    "flowresource": "kinesis",
    "traffictype": "flow",
    "name": "prod-us-east-1",
    "enabled": true,
    "samplerate": 1,
    "region": "us-east-1",
    "shardid": "shardId-000000000000",
    "stream": "flowlogstream",
    "tags": [
      "us-traffic",
      "prod-traffic"
    ],
    "awsauthtype": "AccessKey",
    "accesskeyid": "text",
    "accesssecret": "text",
    "role": {
      "arn": "arn:aws:iam::464179634201:role/Extension"
    }
  }
}

Get VPC

get

Fetches a specific VPC from the ID supplied in the path.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Numeric ID of the VPC to get

Responses

200

Object of a VPCs Requested

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/vpc/{id}

GET /api/v1/vpc/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "id": "731612398",
    "flowtype": "aws",
    "flowresource": "kinesis",
    "traffictype": "flow",
    "name": "prod-us-east-1",
    "enabled": true,
    "samplerate": 1,
    "region": "us-east-1",
    "shardid": "shardId-000000000000",
    "stream": "flowlogstream",
    "tags": [
      "us-traffic",
      "prod-traffic"
    ],
    "awsauthtype": "AccessKey",
    "accesskeyid": "text",
    "accesssecret": "text",
    "role": {
      "arn": "arn:aws:iam::464179634201:role/Extension"
    }
  }
}

Update VPC

put

Update a VPC given the provided object. This does not do a diff. You must send the complete object.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the VPC to be updated

Body

anyOptional

Responses

200

List of VPCs Requested

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

put

/api/v1/vpc/{id}

PUT /api/v1/vpc/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 361

{
  "flowtype": "aws",
  "flowresource": "kinesis",
  "traffictype": "flow",
  "name": "prod-us-east-1",
  "enabled": true,
  "samplerate": 1,
  "region": "us-east-1",
  "shardid": "shardId-000000000000",
  "stream": "flowlogstream",
  "tags": [
    "us-traffic",
    "prod-traffic"
  ],
  "awsauthtype": "AccessKey",
  "accesskeyid": "text",
  "accesssecret": "text",
  "role": {
    "arn": "arn:aws:iam::464179634201:role/Extension"
  }
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "flowtype": "aws",
      "flowresource": "kinesis",
      "traffictype": "flow",
      "name": "prod-us-east-1",
      "enabled": true,
      "samplerate": 1,
      "region": "us-east-1",
      "shardid": "shardId-000000000000",
      "stream": "flowlogstream",
      "tags": [
        "us-traffic",
        "prod-traffic"
      ],
      "awsauthtype": "AccessKey",
      "accesskeyid": "text",
      "accesssecret": "text",
      "role": {
        "arn": "arn:aws:iam::464179634201:role/Extension"
      }
    }
  ]
}

Delete VPC

delete

Deletes the VPC and shuts down the kinesis feed.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the VPC to be retrieved

Responses

204

An empty array

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

delete

/api/v1/vpc/{id}

DELETE /api/v1/vpc/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Enable VPC

put

Enables flow polling for the indicated VPC

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Numeric ID of the VPC to get

Responses

200

List of VPCs Requested

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

put

/api/v1/vpc/{id}/enable

PUT /api/v1/vpc/{id}/enable HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "flowtype": "aws",
      "flowresource": "kinesis",
      "traffictype": "flow",
      "name": "prod-us-east-1",
      "enabled": true,
      "samplerate": 1,
      "region": "us-east-1",
      "shardid": "shardId-000000000000",
      "stream": "flowlogstream",
      "tags": [
        "us-traffic",
        "prod-traffic"
      ],
      "awsauthtype": "AccessKey",
      "accesskeyid": "text",
      "accesssecret": "text",
      "role": {
        "arn": "arn:aws:iam::464179634201:role/Extension"
      }
    }
  ]
}

Disable VPC

put

Disables flow polling for the indicated VPC

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Numeric ID of the VPC to get

Responses

200

List of VPCs Requested

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

put

/api/v1/vpc/{id}/disable

PUT /api/v1/vpc/{id}/disable HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "flowtype": "aws",
      "flowresource": "kinesis",
      "traffictype": "flow",
      "name": "prod-us-east-1",
      "enabled": true,
      "samplerate": 1,
      "region": "us-east-1",
      "shardid": "shardId-000000000000",
      "stream": "flowlogstream",
      "tags": [
        "us-traffic",
        "prod-traffic"
      ],
      "awsauthtype": "AccessKey",
      "accesskeyid": "text",
      "accesssecret": "text",
      "role": {
        "arn": "arn:aws:iam::464179634201:role/Extension"
      }
    }
  ]
}

List VPC Statuses

get

Returns an array of vpc status objects.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of VPC States.

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/vpc/status

GET /api/v1/vpc/status HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "id": 892079680,
      "name": "prod-vpc-east",
      "flowtype": "azure",
      "flowresource": "blobstorage",
      "enabled": true,
      "time": "2022-10-18T17:53:53Z",
      "success": true,
      "attempt": 0,
      "created": "2022-10-18T17:53:53Z",
      "lastupdated": "2022-10-18T17:53:53Z",
      "error": [
        "Invalid credentials"
      ],
      "progress": [
        {
          "step": "COS Session Created",
          "description": "Create client session connection to cloud object storage.",
          "error": "text",
          "status": "pass"
        }
      ]
    }
  ]
}

Fetch VPC Status

get

Fetches a specific VPC from the ID supplied in the path.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the vpc to be returned.

Responses

200

List of VPC States.

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/vpc/status/{id}

GET /api/v1/vpc/status/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "id": 892079680,
      "name": "prod-vpc-east",
      "flowtype": "azure",
      "flowresource": "blobstorage",
      "enabled": true,
      "time": "2022-10-18T17:53:53Z",
      "success": true,
      "attempt": 0,
      "created": "2022-10-18T17:53:53Z",
      "lastupdated": "2022-10-18T17:53:53Z",
      "error": [
        "Invalid credentials"
      ],
      "progress": [
        {
          "step": "COS Session Created",
          "description": "Create client session connection to cloud object storage.",
          "error": "text",
          "status": "pass"
        }
      ]
    }
  ]
}

List VPC Regions

get

Return all regions for each provider.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

An object which contains response metadata information and a data object containing the region array.

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/vpc/regions

GET /api/v1/vpc/regions HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "id": "aws_ap-east-1",
      "description": "Asia Pacific (Hong Kong)",
      "label": "ap-east-1",
      "provider": "aws",
      "region": "us-east-1"
    }
  ]
}

Get VPC regions by flowtype

get

Returns VPC regions for a specific provider/flowtype.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

flowtypestring · enumRequired

Flow Type to filter the VPC regions list by

Possible values:

Responses

200

An object which contains response metadata information and a data object containing the region array.

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/vpc/regions/{flowtype}

GET /api/v1/vpc/regions/{flowtype} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "id": "aws_ap-east-1",
      "description": "Asia Pacific (Hong Kong)",
      "label": "ap-east-1",
      "provider": "aws",
      "region": "us-east-1"
    }
  ]
}

PreviousTraffic Sources DNS Devices NextIntegrations Context

Last updated 8 hours ago

Good evening

List All VPCs

Create VPC

Get VPC by Name

Get VPC

Update VPC

Delete VPC

Enable VPC

Disable VPC

List VPC Statuses

Fetch VPC Status

List VPC Regions

Get VPC regions by flowtype