Edges - Access object to edges

Provides access API to edge resources.

Request Methods

Warning

Be sure to create the access object using edges on client.

client = intdash.Client(...)
client.edges.list(name='foo')
class Edges(...)[source]

Access object to edge resources.

list(name=None, nickname=None, type=None, email=None, disabled=False, sort='name', order='asc', limit=100, page=1, iterator=False)[source]

Retrieves a list of edges.

Parameters
  • name (str) – Edge name

  • nickname (str) – Nickname

  • type (EdgeType) – Edge type

  • email (str) – Mail address

  • disabled (str) – Validity flag

  • sort (str) – Field used for sorting

  • order (str) – Sort order ( asc or desc )

  • limit (int) – Maximum number of items retrieved

  • page (int) – Page number

  • iterator (bool) – If True, generate an iterator.

Returns

List of edge objects

Return type

list[Edge]

me()[source]

Retrieves the own edge accessing intdash.

Returns

Object of the own edge accessing intdash

Return type

Edge

Request Params

class EdgeType(...)[source]

A constant that represents the edge type.

device = 'device'
user = 'user'

Response

class Edge(...)[source]

An object that represents an edge resource.

uuid

UUID

Type

str

name

Edge name

Type

str

description

Description

Type

str

nickname

Nickname

Type

str

type

Edge type

Type

EdgeType

disabled

Invalid flag

Type

bool

created_at

Created time

Type

pandas.Timestamp

updated_at

Updated time

Type

pandas.Timestamp

last_login_at

Last login time

Type

pandas.Timestamp