API Reference

This section of documentation contains information on all of the classes and functions in the taxii2client API, as given by the package’s docstrings.

Subpackages

• taxii2client.v20 package
  • Module contents
    • ApiRoot
      • ApiRoot.collections
      • ApiRoot.custom_properties
      • ApiRoot.description
      • ApiRoot.get_status()
      • ApiRoot.max_content_length
      • ApiRoot.refresh()
      • ApiRoot.refresh_collections()
      • ApiRoot.refresh_information()
      • ApiRoot.title
      • ApiRoot.versions
    • Collection
      • Collection.add_objects()
      • Collection.can_read
      • Collection.can_write
      • Collection.custom_properties
      • Collection.description
      • Collection.get_manifest()
      • Collection.get_object()
      • Collection.get_objects()
      • Collection.id
      • Collection.manifest_url
      • Collection.media_types
      • Collection.objects_url
      • Collection.refresh()
      • Collection.title
    • Server
      • Server.api_roots
      • Server.contact
      • Server.custom_properties
      • Server.default
      • Server.description
      • Server.refresh()
      • Server.title
    • Status
      • Status.custom_properties
      • Status.refresh()
      • Status.wait_until_final()
    • as_pages()
• taxii2client.v21 package
  • Module contents
    • ApiRoot
      • ApiRoot.collections
      • ApiRoot.custom_properties
      • ApiRoot.description
      • ApiRoot.get_status()
      • ApiRoot.max_content_length
      • ApiRoot.refresh()
      • ApiRoot.refresh_collections()
      • ApiRoot.refresh_information()
      • ApiRoot.title
      • ApiRoot.versions
    • Collection
      • Collection.add_objects()
      • Collection.alias
      • Collection.can_read
      • Collection.can_write
      • Collection.custom_properties
      • Collection.delete_object()
      • Collection.description
      • Collection.get_manifest()
      • Collection.get_object()
      • Collection.get_objects()
      • Collection.id
      • Collection.media_types
      • Collection.object_versions()
      • Collection.objects_url
      • Collection.refresh()
      • Collection.title
    • Server
      • Server.api_roots
      • Server.contact
      • Server.custom_properties
      • Server.default
      • Server.description
      • Server.refresh()
      • Server.title
    • Status
      • Status.custom_properties
      • Status.refresh()
      • Status.wait_until_final()
    • as_pages()

Submodules

taxii2client.common module

class taxii2client.common.TokenAuth(key)

Bases: AuthBase

taxii2client.exceptions module

TAXII2 Error Classes.

exception taxii2client.exceptions.AccessError

Bases: TAXIIServiceException

Attempt was made to read/write to a collection when the collection doesn’t allow that operation.

exception taxii2client.exceptions.InvalidArgumentsError

Bases: TAXIIServiceException

Invalid arguments were passed to a method.

exception taxii2client.exceptions.InvalidJSONError

Bases: TAXIIServiceException

A server endpoint gave us invalid JSON

exception taxii2client.exceptions.TAXIIServiceException

Bases: Exception

Base class for exceptions raised by this library.

exception taxii2client.exceptions.ValidationError

Bases: TAXIIServiceException

Data validation failed for a property or group of properties

taxii2client.version module

Module contents

Python TAXII 2 Client