endpoints Package

endpoints Module

models Module

class lemur.endpoints.models.Cipher(**kwargs)

Bases: Model

deprecated
id
name
policy
class lemur.endpoints.models.Endpoint(**kwargs)

Bases: Model

active
aliases
certificate
certificate_id
certificate_path
date_created
property dns_aliases
dnsname
id
property issues
last_updated
name
owner
policy
policy_id
port
registry_type
replaced = ObjectAssociationProxyInstance(AssociationProxy('certificate', 'replaced'))
sensitive
source
source_id
property source_label
type
class lemur.endpoints.models.EndpointDnsAlias(**kwargs)

Bases: Model

alias
endpoint
endpoint_id
id
class lemur.endpoints.models.Policy(**kwargs)

Bases: Model

ciphers
endpoint
id
name

schemas Module

class lemur.endpoints.schemas.CipherNestedOutputSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: LemurOutputSchema

opts = <marshmallow.schema.SchemaOpts object>
class lemur.endpoints.schemas.EndpointOutputSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: LemurOutputSchema

opts = <marshmallow.schema.SchemaOpts object>
class lemur.endpoints.schemas.PolicyNestedOutputSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: LemurOutputSchema

opts = <marshmallow.schema.SchemaOpts object>

service Module

lemur.endpoints.service.create(**kwargs)

Creates a new endpoint. :param kwargs: :return:

lemur.endpoints.service.get(endpoint_id)

Retrieves an endpoint given it’s ID

Parameters:

endpoint_id –

Returns:

lemur.endpoints.service.get_all()

Get all endpoints that are currently in Lemur.

:rtype : List :return:

lemur.endpoints.service.get_all_pending_rotation()

Retrieves all endpoints which have certificates deployed that have been replaced. :return:

lemur.endpoints.service.get_by_dnsname(dnsname)

Retrieves an endpoint given it’s name.

Parameters:

dnsname –

Returns:

lemur.endpoints.service.get_by_dnsname_and_port(dnsname, port)

Retrieves and endpoint by it’s dnsname and port. :param dnsname: :param port: :return:

lemur.endpoints.service.get_by_name(name)

Retrieves an endpoint given it’s name.

Parameters:

name –

Returns:

lemur.endpoints.service.get_by_name_and_source(name, source)

Retrieves an endpoint by it’s name and source. :param name: :param source: :return:

lemur.endpoints.service.get_by_source(source_label)

Retrieves all endpoints for a given source. :param source_label: :return:

lemur.endpoints.service.get_or_create_cipher(**kwargs)
lemur.endpoints.service.get_or_create_policy(**kwargs)
lemur.endpoints.service.render(args)

Helper that helps us render the REST Api responses. :param args: :return:

lemur.endpoints.service.stats(**kwargs)

Helper that defines some useful statistics about endpoints.

Parameters:

kwargs –

Returns:

lemur.endpoints.service.update(endpoint_id, **kwargs)

views Module

class lemur.endpoints.views.Endpoints

Bases: AuthenticatedResource

endpoint = 'endpoint'
get(endpoint_id)
GET /endpoints/1

One endpoint

Example request:

GET /endpoints/1 HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript
Request Headers:
Status Codes:
mediatypes()
methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class lemur.endpoints.views.EndpointsList

Bases: AuthenticatedResource

Defines the ‘endpoints’ endpoint

endpoint = 'endpoints'
get()
GET /endpoints

The current list of endpoints

Example request:

GET /endpoints HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript
Query Parameters:

  • sortBy – field to sort on

  • sortDir – asc or desc

  • page – int default is 1

  • filter – key value pair. format is k;v

  • limit – limit number default is 10

Request Headers:
Status Codes:
Note:

this will only show certificates that the current user is authorized to use

mediatypes()
methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.