nsone.rest¶

A thin layer over the NSONE REST API

exception nsone.rest.errors.AuthException(message, response=None, body=None)¶: Bases: nsone.rest.errors.ResourceException

exception nsone.rest.errors.RateLimitException(message, response=None, body=None)¶: Bases: nsone.rest.errors.ResourceException

exception nsone.rest.errors.ResourceException(message, response=None, body=None)¶: Bases: exceptions.Exception

class nsone.rest.resource.BaseResource(config)¶

Parameters:	config (nsone.config.Config) – config object used to build requests

BOOL_FIELDS = []¶

DEFAULT_TRANSPORT = 'requests'¶

INT_FIELDS = []¶

PASSTHRU_FIELDS = []¶

class nsone.rest.data.Feed(config)¶

Bases: nsone.rest.resource.BaseResource

Parameters:	config (nsone.config.Config) – config object used to build requests

PASSTHRU_FIELDS = ['name', 'config']¶

ROOT = 'data/feeds'¶

create(sourceid, name, config, callback=None, errback=None, **kwargs)¶

delete(sourceid, feedid, callback=None, errback=None)¶

list(sourceid, callback=None, errback=None)¶

retrieve(sourceid, feedid, callback=None, errback=None)¶

update(sourceid, feedid, callback=None, errback=None, **kwargs)¶

class nsone.rest.data.Source(config)¶

Bases: nsone.rest.resource.BaseResource

Parameters:	config (nsone.config.Config) – config object used to build requests

PASSTHRU_FIELDS = ['name', 'config']¶

ROOT = 'data/sources'¶

create(name, sourcetype, callback=None, errback=None, **kwargs)¶

delete(sourceid, callback=None, errback=None)¶

list(callback=None, errback=None)¶

publish(sourceid, data, callback=None, errback=None)¶

retrieve(sourceid, callback=None, errback=None)¶

update(sourceid, callback=None, errback=None, **kwargs)¶

class nsone.rest.stats.Stats(config)¶

Bases: nsone.rest.resource.BaseResource

Parameters:	config (nsone.config.Config) – config object used to build requests

ROOT = 'stats'¶

qps(zone=None, domain=None, type=None, callback=None, errback=None)¶

usage(zone=None, domain=None, type=None, callback=None, errback=None, **kwargs)¶

class nsone.rest.records.Records(config)¶

Bases: nsone.rest.resource.BaseResource

Parameters:	config (nsone.config.Config) – config object used to build requests

BOOL_FIELDS = ['use_csubnet', 'override_ttl']¶

INT_FIELDS = ['ttl']¶

PASSTHRU_FIELDS = ['networks', 'meta', 'regions', 'link']¶

ROOT = 'zones'¶

create(zone, domain, type, callback=None, errback=None, **kwargs)¶

create_raw(zone, domain, type, body, callback=None, errback=None, **kwargs)¶

delete(zone, domain, type, callback=None, errback=None)¶

retrieve(zone, domain, type, callback=None, errback=None)¶

update(zone, domain, type, callback=None, errback=None, **kwargs)¶

class nsone.rest.zones.Zones(config)¶

Bases: nsone.rest.resource.BaseResource

Parameters:	config (nsone.config.Config) – config object used to build requests

INT_FIELDS = ['retry', 'refresh', 'expiry', 'nx_ttl']¶

PASSTHRU_FIELDS = ['secondary', 'hostmaster', 'meta', 'networks', 'link']¶

ROOT = 'zones'¶

create(zone, callback=None, errback=None, **kwargs)¶

delete(zone, callback=None, errback=None)¶

import_file(zone, zoneFile, callback=None, errback=None, **kwargs)¶

list(callback=None, errback=None)¶

retrieve(zone, callback=None, errback=None)¶

update(zone, callback=None, errback=None, **kwargs)¶