defaults Package¶
defaults
Module¶
schemas
Module¶
- class lemur.defaults.schemas.DefaultOutputSchema(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>
views
Module¶
- class lemur.defaults.views.LemurDefaults
Bases:
AuthenticatedResource
Defines the ‘defaults’ endpoint
- endpoint = 'default'
- get()
- GET /defaults¶
Returns defaults needed to generate CSRs
Example request:
GET /defaults HTTP/1.1 Host: example.com Accept: application/json, text/javascript
Example response:
HTTP/1.1 200 OK Vary: Accept Content-Type: text/javascript { "country": "US", "state": "CA", "location": "Los Gatos", "organization": "Netflix", "organizationalUnit": "Operations", "dnsProviders": [{"name": "test", ...}, {...}], }
- Request Headers:
Authorization – OAuth token to authenticate
- Status Codes:
200 OK – no error
403 Forbidden – unauthenticated
- mediatypes()
- methods: t.ClassVar[t.Collection[str] | None] = {'GET'}
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]
) asroute
andadd_url_rule
by default.