`archivebox.api.v1_core`

Module Contents

Classes

`CustomPagination`
`MinimalArchiveResultSchema`
`ArchiveResultSchema`
`ArchiveResultFilterSchema`
`SnapshotSchema`
`SnapshotFilterSchema`
`TagSchema`

Functions

`get_archiveresults`	List all ArchiveResult entries matching these filters.
`get_archiveresult`	Get a specific ArchiveResult by id or abid.
`get_snapshots`	List all Snapshot entries matching these filters.
`get_snapshot`	Get a specific Snapshot by abid or id.
`get_tags`
`get_tag`
`get_any`	Get any object by its ABID or ID (e.g. snapshot, archiveresult, tag, seed, crawl, etc.).

Data

router

API

archivebox.api.v1_core.router[source]: ‘Router(…)’

class archivebox.api.v1_core.CustomPagination[source]

Bases: ninja.pagination.PaginationBase

class Input[source]

Bases: ninja.Schema

limit: int[source]: 200

offset: int[source]: 0

page: int[source]: 0

class Output[source]

Bases: ninja.Schema

total_items: int[source]: None

total_pages: int[source]: None

page: int[source]: None

limit: int[source]: None

offset: int[source]: None

num_items: int[source]: None

items: List[Any][source]: None

paginate_queryset(queryset, pagination: Input, **params)[source]

class archivebox.api.v1_core.MinimalArchiveResultSchema[source]

Bases: ninja.Schema

TYPE: str[source]: ‘core.models.ArchiveResult’

id: uuid.UUID[source]: None

abid: str[source]: None

created_at: datetime.datetime | None[source]: None

modified_at: datetime.datetime | None[source]: None

created_by_id: str[source]: None

created_by_username: str[source]: None

status: str[source]: None

retry_at: datetime.datetime | None[source]: None

extractor: str[source]: None

cmd_version: str | None[source]: None

cmd: list[str] | None[source]: None

pwd: str | None[source]: None

output: str | None[source]: None

start_ts: datetime.datetime | None[source]: None

end_ts: datetime.datetime | None[source]: None

static resolve_created_by_id(obj)[source]

static resolve_created_by_username(obj) → str[source]

static resolve_abid(obj)[source]

static resolve_snapshot_timestamp(obj)[source]

static resolve_snapshot_url(obj)[source]

static resolve_snapshot_id(obj)[source]

static resolve_snapshot_abid(obj)[source]

static resolve_snapshot_tags(obj)[source]

class archivebox.api.v1_core.ArchiveResultSchema[source]

Bases: archivebox.api.v1_core.MinimalArchiveResultSchema

TYPE: str[source]: ‘core.models.ArchiveResult’

snapshot_id: uuid.UUID[source]: None

snapshot_abid: str[source]: None

snapshot_timestamp: str[source]: None

snapshot_url: str[source]: None

snapshot_tags: List[str][source]: None

class archivebox.api.v1_core.ArchiveResultFilterSchema[source]

Bases: ninja.FilterSchema

id: Optional[str][source]: ‘Field(…)’

search: Optional[str][source]: ‘Field(…)’

snapshot_id: Optional[str][source]: ‘Field(…)’

snapshot_url: Optional[str][source]: ‘Field(…)’

snapshot_tag: Optional[str][source]: ‘Field(…)’

status: Optional[str][source]: ‘Field(…)’

output: Optional[str][source]: ‘Field(…)’

extractor: Optional[str][source]: ‘Field(…)’

cmd: Optional[str][source]: ‘Field(…)’

pwd: Optional[str][source]: ‘Field(…)’

cmd_version: Optional[str][source]: ‘Field(…)’

created_at: Optional[datetime.datetime][source]: ‘Field(…)’

created_at__gte: Optional[datetime.datetime][source]: ‘Field(…)’

created_at__lt: Optional[datetime.datetime][source]: ‘Field(…)’

archivebox.api.v1_core.get_archiveresults(request, filters: archivebox.api.v1_core.ArchiveResultFilterSchema = Query(...))[source]: List all ArchiveResult entries matching these filters.

archivebox.api.v1_core.get_archiveresult(request, archiveresult_id: str)[source]: Get a specific ArchiveResult by id or abid.

class archivebox.api.v1_core.SnapshotSchema[source]

Bases: ninja.Schema

TYPE: str[source]: ‘core.models.Snapshot’

id: uuid.UUID[source]: None

abid: str[source]: None

created_by_id: str[source]: None

created_by_username: str[source]: None

created_at: datetime.datetime[source]: None

modified_at: datetime.datetime[source]: None

status: str[source]: None

retry_at: datetime.datetime | None[source]: None

bookmarked_at: datetime.datetime[source]: None

downloaded_at: Optional[datetime.datetime][source]: None

url: str[source]: None

tags: List[str][source]: None

title: Optional[str][source]: None

timestamp: str[source]: None

archive_path: str[source]: None

num_archiveresults: int[source]: None

archiveresults: List[archivebox.api.v1_core.MinimalArchiveResultSchema][source]: None

static resolve_created_by_id(obj)[source]

static resolve_created_by_username(obj)[source]

static resolve_abid(obj)[source]

static resolve_tags(obj)[source]

static resolve_num_archiveresults(obj, context)[source]

static resolve_archiveresults(obj, context)[source]

class archivebox.api.v1_core.SnapshotFilterSchema[source]

Bases: ninja.FilterSchema

id: Optional[str][source]: ‘Field(…)’

abid: Optional[str][source]: ‘Field(…)’

created_by_id: str[source]: ‘Field(…)’

created_by_username: str[source]: ‘Field(…)’

created_at__gte: datetime.datetime[source]: ‘Field(…)’

created_at__lt: datetime.datetime[source]: ‘Field(…)’

created_at: datetime.datetime[source]: ‘Field(…)’

modified_at: datetime.datetime[source]: ‘Field(…)’

modified_at__gte: datetime.datetime[source]: ‘Field(…)’

modified_at__lt: datetime.datetime[source]: ‘Field(…)’

search: Optional[str][source]: ‘Field(…)’

url: Optional[str][source]: ‘Field(…)’

tag: Optional[str][source]: ‘Field(…)’

title: Optional[str][source]: ‘Field(…)’

timestamp: Optional[str][source]: ‘Field(…)’

bookmarked_at__gte: Optional[datetime.datetime][source]: ‘Field(…)’

bookmarked_at__lt: Optional[datetime.datetime][source]: ‘Field(…)’

archivebox.api.v1_core.get_snapshots(request, filters: archivebox.api.v1_core.SnapshotFilterSchema = Query(...), with_archiveresults: bool = False)[source]: List all Snapshot entries matching these filters.

archivebox.api.v1_core.get_snapshot(request, snapshot_id: str, with_archiveresults: bool = True)[source]: Get a specific Snapshot by abid or id.

class archivebox.api.v1_core.TagSchema[source]

Bases: ninja.Schema

TYPE: str[source]: ‘core.models.Tag’

id: uuid.UUID[source]: None

abid: str[source]: None

modified_at: datetime.datetime[source]: None

created_at: datetime.datetime[source]: None

created_by_id: str[source]: None

created_by_username: str[source]: None

name: str[source]: None

slug: str[source]: None

num_snapshots: int[source]: None

snapshots: List[archivebox.api.v1_core.SnapshotSchema][source]: None

static resolve_created_by_id(obj)[source]

static resolve_created_by_username(obj)[source]

static resolve_num_snapshots(obj, context)[source]

static resolve_snapshots(obj, context)[source]

archivebox.api.v1_core.get_tags(request)[source]

archivebox.api.v1_core.get_tag(request, tag_id: str, with_snapshots: bool = True)[source]

archivebox.api.v1_core.get_any(request, abid: str)[source]: Get any object by its ABID or ID (e.g. snapshot, archiveresult, tag, seed, crawl, etc.).

archivebox.api.v1_core

Module Contents

Classes

Functions

Data

API

`archivebox.api.v1_core`