Labels Ports

List Port Labels

get

Returns an array of port labels.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of Port Labels 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/labels/ports

HTTPcURLJavaScriptPython

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

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "protocol": "udp",
      "port": 1,
      "default": true,
      "hasdefault": true,
      "hide": false,
      "labels": [
        "test"
      ]
    }
  ]
}

Create Port Label

post

Creates a port label from the data that's been supplied

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Port Label Create Config

protocolstringRequired

Protocol.

Example: udp

portnumberRequired

Port

Example: 1

labelsstring[] · min: 1 · max: 10000Required

Labels for port

Example: ["test"]

Responses

201

Port Label 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/labels/ports

HTTPcURLJavaScriptPython

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

{
  "protocol": "udp",
  "port": 1,
  "labels": [
    "test"
  ]
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "protocol": "udp",
    "port": 1,
    "default": true,
    "hasdefault": true,
    "hide": false,
    "labels": [
      "test"
    ]
  }
}

Update Port Label

put

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Port Label Create Config

protocolstringRequired

Protocol.

Example: udp

portnumberRequired

Port

Example: 1

labelsstring[] · min: 1 · max: 10000Required

Labels for port

Example: ["test"]

Responses

200

Port Label 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/labels/ports

HTTPcURLJavaScriptPython

PUT /api/v1/labels/ports HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "protocol": "udp",
  "port": 1,
  "labels": [
    "test"
  ]
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "protocol": "udp",
    "port": 1,
    "default": true,
    "hasdefault": true,
    "hide": false,
    "labels": [
      "test"
    ]
  }
}

List Configured Protocols

get

Returns an array of protocols.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of Port Labels Protocols 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/labels/ports/protocols

HTTPcURLJavaScriptPython

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

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

List Port Labels by protocol

get

Fetches all labels by a specific protocol for all Ports.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

protocolstringRequired

The protocol of the Port labels to be returned.

Responses

200

Port Label 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/labels/ports/all/{protocol}

HTTPcURLJavaScriptPython

GET /api/v1/labels/ports/all/{protocol} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "protocol": "udp",
    "port": 1,
    "default": true,
    "hasdefault": true,
    "hide": false,
    "labels": [
      "test"
    ]
  }
}

List Port Labels by port

get

Fetches a all Port labels for the port supplied in the path.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

portstringRequired

The Port number of the Port labels to be returned.

Responses

200

Port Label 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/labels/ports/{port}

HTTPcURLJavaScriptPython

GET /api/v1/labels/ports/{port} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "protocol": "udp",
    "port": 1,
    "default": true,
    "hasdefault": true,
    "hide": false,
    "labels": [
      "test"
    ]
  }
}

Fetch Port Label

get

Fetches a specific port label from the protocol and port supplied in the path.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

portstringRequired

The port of the port label to be returned.

protocolstringRequired

The protocol of the port label to be returned.

Responses

200

Port Label 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/labels/{port}/{protocol}

HTTPcURLJavaScriptPython

GET /api/v1/labels/{port}/{protocol} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "protocol": "udp",
    "port": 1,
    "default": true,
    "hasdefault": true,
    "hide": false,
    "labels": [
      "test"
    ]
  }
}

Delete Port Label by port:protocol

delete

Delete Port Label

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

portstringRequired

The port of the port label to be deleted.

protocolstringRequired

The protocol of the port label to be deleted.

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/labels/{port}/{protocol}

HTTPcURLJavaScriptPython

DELETE /api/v1/labels/{port}/{protocol} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Expose Port Label

put

Expose (un-hide) a hidden system port label.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

portstringRequired

The port of the port label to be exposed. Labels in this protocol will now appear for this Port in the UI.

protocolstringRequired

The protocol of the port label to be shown.

Responses

200

Port Label 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/labels/ports/{port}/{protocol}/show

HTTPcURLJavaScriptPython

PUT /api/v1/labels/ports/{port}/{protocol}/show HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "protocol": "udp",
    "port": 1,
    "default": true,
    "hasdefault": true,
    "hide": false,
    "labels": [
      "test"
    ]
  }
}

Hide Port Label

put

Hide system port label.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

portstringRequired

The port of the port label to be hidden.

protocolstringRequired

The protocol of the port label to be hidden.

Responses

200

Port Label 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/labels/ports/{port}/{protocol}/hide

HTTPcURLJavaScriptPython

PUT /api/v1/labels/ports/{port}/{protocol}/hide HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "protocol": "udp",
    "port": 1,
    "default": true,
    "hasdefault": true,
    "hide": false,
    "labels": [
      "test"
    ]
  }
}

Reset Port Label

put

Reset system port label to default state.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

portstringRequired

The port of the port label to be reset.

protocolstringRequired

The protocol of the port label to be reset.

Responses

200

Port Label 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/labels/ports/{port}/{protocol}/reset

HTTPcURLJavaScriptPython

PUT /api/v1/labels/ports/{port}/{protocol}/reset HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "protocol": "udp",
    "port": 1,
    "default": true,
    "hasdefault": true,
    "hide": false,
    "labels": [
      "test"
    ]
  }
}

Bulk Upload Port Labels

put

Bulk upload port labels. New labels will be created, and existing labels will be replaced. Limited to 10,000 labels per request.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

Port Label Create Config

protocolstringRequired

Protocol.

Example: udp

portnumberRequired

Port

Example: 1

labelsstring[] · min: 1 · max: 10000Required

Labels for port

Example: ["test"]

Responses

201

Result of Port Labels bulk upload

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/labels/ports/bulk

HTTPcURLJavaScriptPython

PUT /api/v1/labels/ports/bulk HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

[
  {
    "protocol": "udp",
    "port": 1,
    "labels": [
      "test"
    ]
  }
]

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "protocol": "udp",
      "port": 1,
      "default": true,
      "hasdefault": true,
      "hide": false,
      "labels": [
        "test"
      ]
    }
  ]
}

Bulk Delete Port Labels

delete

Bulk delete port labels from the data that's been supplied

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

Delete Port Labels via port or protocol or both. One of port or protocol is required. Both may be provided as well.

portnumberOptional

Port. Optional if protocol is provided.

Example: 1

protocolstringOptional

Protocol. Optional is port is provided.

Example: udp

Responses

201

Result of Port Labels bulk upload

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

delete

/api/v1/labels/ports/bulk

HTTPcURLJavaScriptPython

DELETE /api/v1/labels/ports/bulk HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

[
  {
    "port": 1,
    "protocol": "udp"
  }
]

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "protocol": "udp",
      "port": 1,
      "default": true,
      "hasdefault": true,
      "hide": false,
      "labels": [
        "test"
      ]
    }
  ]
}

Upload Port Labels

put

Upload Port labels via a CSV file. New labels will be created, and existing labels will be replaced. Limited to 10,000 labels per request. The CSV must be a text file and should NOT have any headers. Multiple labels can be assigned per protocol by having additional columns. Example CSV: Port1, Protocol1, Label1 Port1, Protocol2, Label1, Label2 Port2, Protocol1, Label3 Port2, Protocol4, Label4, Label5, Label6

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

multipart/form-data

filestring · textRequired

The CSV file to upload

Responses

201

Result of Port Labels bulk upload

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/labels/ports/upload

HTTPcURLJavaScriptPython

PUT /api/v1/labels/ports/upload HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15

{
  "file": "text"
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "protocol": "udp",
      "port": 1,
      "default": true,
      "hasdefault": true,
      "hide": false,
      "labels": [
        "test"
      ]
    }
  ]
}