Tags

List Tags

get

Return a list of all Tags.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

terseintegerOptional

boolean as integer. default 1 (true). 0 for false. true will return a simple array of tags, e.g. [ 'tag1', 'tag2', 'tag3', ... ]

Example: 0

Responses

200

An array of Tags

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/tags

HTTPcURLJavaScriptPython

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

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "entitytype": "flow",
      "entityname": "Flow Rule 1",
      "entityid": 325067628,
      "tag": "mytag"
    }
  ]
}

List Tags by Entity Type

get

Return a list of all Tags.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

entitytypestring · enumRequired

Entity Type of the Tags, e.g. device, flow, vpc

Possible values:

Query parameters

terseintegerOptional

boolean as integer. default 1 (true). 0 for false. true will return a simple array of tags, e.g. [ 'tag1', 'tag2', 'tag3', ... ]

Example: 0

Responses

200

An array of Tags

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/tags/{entitytype}

HTTPcURLJavaScriptPython

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

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "entitytype": "flow",
      "entityname": "Flow Rule 1",
      "entityid": 325067628,
      "tag": "mytag"
    }
  ]
}

Get Tag Values for IP

get

Returns all tag values associated with a specific IP address within the specified timeframe.

This endpoint allows you to retrieve all tags that have been applied to flows associated with the given IP address during the specified time period.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ipstringRequired

The IP address to retrieve tag values for

Example: 20.60.146.129

startintegerRequired

Start time for the query. Negative values represent lookback time in seconds from now (e.g., -86400 for 24 hours ago), or positive values represent Unix timestamp in seconds.

Example: -86400

endintegerRequired

End time for the query. Negative values represent lookback time in seconds from now (e.g., -3600 for 1 hour ago), 0 for current time, or positive values represent Unix timestamp in seconds.

Example: 0

Responses

200

Tag values for an IP address within a timeframe

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/tags/ip

HTTPcURLJavaScriptPython

GET /api/v1/tags/ip?ip=text&start=1&end=1 HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    "web-traffic"
  ]
}

Create Flow Tag

post

Create a Tag given the provided object.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

201

An array of Flow Tags

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/tag/flow

HTTPcURLJavaScriptPython

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

{
  "id": "325068886",
  "name": "customer-web-traffic",
  "tags": [
    "customer",
    "web"
  ],
  "dstnets": [
    "10.0.0.0/24",
    "192.168.0.0/16"
  ],
  "dstport": 80,
  "protocol": "tcp"
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": []
}

Get Flow Tag

get

Fetches a specific Flow Tag from the ID supplied in the path.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the Flow Tag to be returned.

Responses

200

An array of Flow Tags

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/tag/flow/{id}

HTTPcURLJavaScriptPython

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

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": []
}

Update Flow Tag

put

Update a Flow Tag given the provided object. This does not do a diff. You must send the complete object and have at least 1 match criteria set.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the Flow Tag Rule to be updated

Body

application/json

namestringRequired

The name of the Flow Tag Rule. Eg. carrier tags

tagsstring[]Required

An array of strings to tag every flow that matches this response policy (rule) with

inputaliasregexstringOptional

A regular expression that matches against inputalias of a given flow record.

inputnameregexstringOptional

A regular expression that matches against inputname of the input interface of a given flow record.

outputaliasregexstringOptional

A regular expression that matches against outputalias of a given flow record.

outputnameregexstringOptional

A regular expression that matches against outputname of a given flow record.

srcnetsstring[]Optional

An array of CIDR blocks to match against the source IP for a given flow record.

dstnetsstring[]Optional

An array of CIDR blocks to match against the destination IP for a given flow record.

srcportinteger · int32Optional

Source port to match against a given flow.

dstportinteger · int32Optional

Destination port to match against a given flow.

protocolstringOptional

lower case string representing the protocol of this flow. Eg. tcp, udp, icmp etc

tcpflagsintinteger · int32Optional

integer representing which tcp flags were set in the flow record. Values between 0-255 are valid.

srcasinteger[]Optional

An array of AS numbers to match against the source AS for a given flow record.

dstasinteger[]Optional

An array of AS numbers to match against the destination AS for a given flow record.

srcownerasinteger[]Optional

An array of AS numbers to match against the AS of the source IP for a given flow record.

dstownerasinteger[]Optional

An array of AS numbers to match against the AS of the destination IP for a given flow record.

Responses

200

An array of Flow Tags

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/tag/flow/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "325068886",
  "name": "customer-web-traffic",
  "tags": [
    "customer",
    "web"
  ],
  "dstnets": [
    "10.0.0.0/24",
    "192.168.0.0/16"
  ],
  "dstport": 80,
  "protocol": "tcp"
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": []
}

Delete Flow Tag

delete

Deletes the Flow Tag.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the Flow Tag Rule to be deleted

Responses

204

Empty response

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/tag/flow/{id}

HTTPcURLJavaScriptPython

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

No content