genvid.toolbox.LinksAPI

class genvid.toolbox.LinksAPI(parent_api: genvid.toolbox.httpapi.BaseHttpApiTool, **kwargs)

Bases: genvid.toolbox.httpapi.BaseHttpApiTool

The links api. See Bastion API and Cluster API

New in version 1.15.0.

NAME = 'links-api'
get_base_url(timeout=0.0) → str

Get the base URL.

Get the links.

Get the URI links to the multiple applications by category. Current categories are global, monitor and project.
Parameters:
  • name
  • category – Filter the results by category

New in version 1.15.0.

Get the list of all link definitions.

Parameters:timeout – The timeout in seconds.

New in version 1.15.0.

Get a link definitions.

Parameters:
  • link_id – The link ID.
  • timeout – The timeout in seconds.

New in version 1.15.0.

Create a link definitions.

Parameters:
  • link_id – The job ID.
  • link – The link definition.
  • timeout – The timeout in seconds.

New in version 1.15.0.

Delete all link definitions.

Parameters:timeout – The timeout in seconds.

New in version 1.15.0.

Delete a link definitions.

Parameters:
  • link_id – The link ID.
  • timeout – The timeout in seconds.

New in version 1.15.0.

class api_links.LinksAPI

Implementation of genvid.toolbox.LinksAPI