Atlos Database#

Module type

database

Handles integration with the Atlos platform for managing archival results.

Features#

  • Outputs archival results to the Atlos API for storage and tracking.

  • Updates failure status with error details when archiving fails.

  • Processes and formats metadata, including ISO formatting for datetime fields.

  • Skips processing for items without an Atlos ID.

Setup#

Required configs:

  • atlos_url: Base URL for the Atlos API.

  • api_token: Authentication token for API access.

Configuration Options#

YAML#

atlos_db:
  api_token:
  atlos_url: https://platform.atlos.org

Command Line:#

Option

Description

Default

Type

atlos_db.api_token

Required. An Atlos API token. For more information, see https://docs.atlos.org/technical/api/

None

string

atlos_db.atlos_url

Optional. The URL of your Atlos instance (e.g., https://platform.atlos.org), without a trailing slash.

https://platform.atlos.org

string

API Reference