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

200Success

No content

400Error

401Error

403Error

default

get

/api/v1/tags

HTTPcURLJavaScriptPython

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

{
  "$ref": "./responses/tags.yaml"
}

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

200Success

No content

400Error

401Error

403Error

default

get

/api/v1/tags/{entitytype}

HTTPcURLJavaScriptPython

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

{
  "$ref": "./responses/tags.yaml"
}

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

anyOptional

Responses

201Success

400Error

401Error

403Error

default

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: */*

{
  "$ref": "./responses/flow_tag.yaml"
}

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

200Success

No content

400Error

401Error

403Error

default

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: */*

{
  "$ref": "./responses/flow_tag.yaml"
}

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

anyOptional

Responses

200Success

No content

400Error

401Error

403Error

default

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: */*

{
  "$ref": "./responses/flow_tag.yaml"
}

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

400Error

401Error

403Error

default

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