{py:mod}archivebox.api.v1_crawls

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`CrawlSchema <archivebox.api.v1_crawls.CrawlSchema>`
  -
* - {py:obj}`CrawlUpdateSchema <archivebox.api.v1_crawls.CrawlUpdateSchema>`
  -
* - {py:obj}`CrawlCreateSchema <archivebox.api.v1_crawls.CrawlCreateSchema>`
  -
* - {py:obj}`CrawlDeleteResponseSchema <archivebox.api.v1_crawls.CrawlDeleteResponseSchema>`
  -

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`normalize_tag_list <archivebox.api.v1_crawls.normalize_tag_list>`
  - ```{autodoc2-docstring} archivebox.api.v1_crawls.normalize_tag_list
    :summary:
    ```
* - {py:obj}`get_crawls <archivebox.api.v1_crawls.get_crawls>`
  - ```{autodoc2-docstring} archivebox.api.v1_crawls.get_crawls
    :summary:
    ```
* - {py:obj}`create_crawl <archivebox.api.v1_crawls.create_crawl>`
  - ```{autodoc2-docstring} archivebox.api.v1_crawls.create_crawl
    :summary:
    ```
* - {py:obj}`get_crawl <archivebox.api.v1_crawls.get_crawl>`
  - ```{autodoc2-docstring} archivebox.api.v1_crawls.get_crawl
    :summary:
    ```
* - {py:obj}`patch_crawl <archivebox.api.v1_crawls.patch_crawl>`
  - ```{autodoc2-docstring} archivebox.api.v1_crawls.patch_crawl
    :summary:
    ```
* - {py:obj}`delete_crawl <archivebox.api.v1_crawls.delete_crawl>`
  - ```{autodoc2-docstring} archivebox.api.v1_crawls.delete_crawl
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`router <archivebox.api.v1_crawls.router>`
  - ```{autodoc2-docstring} archivebox.api.v1_crawls.router
    :summary:
    ```

API

:canonical: archivebox.api.v1_crawls.router
:value: >
   'Router(...)'

```{autodoc2-docstring} archivebox.api.v1_crawls.router
```

:canonical: archivebox.api.v1_crawls.CrawlSchema

Bases: {py:obj}`ninja.Schema`

````{py:attribute} TYPE
:canonical: archivebox.api.v1_crawls.CrawlSchema.TYPE
:type: str
:value: >
   'crawls.models.Crawl'

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.TYPE
```

````

````{py:attribute} id
:canonical: archivebox.api.v1_crawls.CrawlSchema.id
:type: uuid.UUID
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.id
```

````

````{py:attribute} modified_at
:canonical: archivebox.api.v1_crawls.CrawlSchema.modified_at
:type: datetime.datetime
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.modified_at
```

````

````{py:attribute} created_at
:canonical: archivebox.api.v1_crawls.CrawlSchema.created_at
:type: datetime.datetime
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.created_at
```

````

````{py:attribute} created_by_id
:canonical: archivebox.api.v1_crawls.CrawlSchema.created_by_id
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.created_by_id
```

````

````{py:attribute} created_by_username
:canonical: archivebox.api.v1_crawls.CrawlSchema.created_by_username
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.created_by_username
```

````

````{py:attribute} status
:canonical: archivebox.api.v1_crawls.CrawlSchema.status
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.status
```

````

````{py:attribute} retry_at
:canonical: archivebox.api.v1_crawls.CrawlSchema.retry_at
:type: datetime.datetime | None
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.retry_at
```

````

````{py:attribute} urls
:canonical: archivebox.api.v1_crawls.CrawlSchema.urls
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.urls
```

````

````{py:attribute} max_depth
:canonical: archivebox.api.v1_crawls.CrawlSchema.max_depth
:type: int
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.max_depth
```

````

````{py:attribute} tags_str
:canonical: archivebox.api.v1_crawls.CrawlSchema.tags_str
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.tags_str
```

````

````{py:attribute} config
:canonical: archivebox.api.v1_crawls.CrawlSchema.config
:type: dict
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.config
```

````

````{py:method} resolve_created_by_id(obj)
:canonical: archivebox.api.v1_crawls.CrawlSchema.resolve_created_by_id
:staticmethod:

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.resolve_created_by_id
```

````

````{py:method} resolve_created_by_username(obj)
:canonical: archivebox.api.v1_crawls.CrawlSchema.resolve_created_by_username
:staticmethod:

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.resolve_created_by_username
```

````

````{py:method} resolve_snapshots(obj, context)
:canonical: archivebox.api.v1_crawls.CrawlSchema.resolve_snapshots
:staticmethod:

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlSchema.resolve_snapshots
```

````

:canonical: archivebox.api.v1_crawls.CrawlUpdateSchema

Bases: {py:obj}`ninja.Schema`

````{py:attribute} status
:canonical: archivebox.api.v1_crawls.CrawlUpdateSchema.status
:type: str | None
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlUpdateSchema.status
```

````

````{py:attribute} retry_at
:canonical: archivebox.api.v1_crawls.CrawlUpdateSchema.retry_at
:type: datetime.datetime | None
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlUpdateSchema.retry_at
```

````

````{py:attribute} tags
:canonical: archivebox.api.v1_crawls.CrawlUpdateSchema.tags
:type: typing.Optional[typing.List[str]]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlUpdateSchema.tags
```

````

````{py:attribute} tags_str
:canonical: archivebox.api.v1_crawls.CrawlUpdateSchema.tags_str
:type: str | None
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlUpdateSchema.tags_str
```

````

:canonical: archivebox.api.v1_crawls.CrawlCreateSchema

Bases: {py:obj}`ninja.Schema`

````{py:attribute} urls
:canonical: archivebox.api.v1_crawls.CrawlCreateSchema.urls
:type: typing.List[str]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlCreateSchema.urls
```

````

````{py:attribute} max_depth
:canonical: archivebox.api.v1_crawls.CrawlCreateSchema.max_depth
:type: int
:value: >
   0

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlCreateSchema.max_depth
```

````

````{py:attribute} tags
:canonical: archivebox.api.v1_crawls.CrawlCreateSchema.tags
:type: typing.Optional[typing.List[str]]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlCreateSchema.tags
```

````

````{py:attribute} tags_str
:canonical: archivebox.api.v1_crawls.CrawlCreateSchema.tags_str
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlCreateSchema.tags_str
```

````

````{py:attribute} label
:canonical: archivebox.api.v1_crawls.CrawlCreateSchema.label
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlCreateSchema.label
```

````

````{py:attribute} notes
:canonical: archivebox.api.v1_crawls.CrawlCreateSchema.notes
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlCreateSchema.notes
```

````

````{py:attribute} config
:canonical: archivebox.api.v1_crawls.CrawlCreateSchema.config
:type: dict
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlCreateSchema.config
```

````

:canonical: archivebox.api.v1_crawls.CrawlDeleteResponseSchema

Bases: {py:obj}`ninja.Schema`

````{py:attribute} success
:canonical: archivebox.api.v1_crawls.CrawlDeleteResponseSchema.success
:type: bool
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlDeleteResponseSchema.success
```

````

````{py:attribute} crawl_id
:canonical: archivebox.api.v1_crawls.CrawlDeleteResponseSchema.crawl_id
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlDeleteResponseSchema.crawl_id
```

````

````{py:attribute} deleted_count
:canonical: archivebox.api.v1_crawls.CrawlDeleteResponseSchema.deleted_count
:type: int
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlDeleteResponseSchema.deleted_count
```

````

````{py:attribute} deleted_snapshots
:canonical: archivebox.api.v1_crawls.CrawlDeleteResponseSchema.deleted_snapshots
:type: int
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_crawls.CrawlDeleteResponseSchema.deleted_snapshots
```

````

:canonical: archivebox.api.v1_crawls.normalize_tag_list

```{autodoc2-docstring} archivebox.api.v1_crawls.normalize_tag_list
```

:canonical: archivebox.api.v1_crawls.get_crawls

```{autodoc2-docstring} archivebox.api.v1_crawls.get_crawls
```

:canonical: archivebox.api.v1_crawls.create_crawl

```{autodoc2-docstring} archivebox.api.v1_crawls.create_crawl
```

:canonical: archivebox.api.v1_crawls.get_crawl

```{autodoc2-docstring} archivebox.api.v1_crawls.get_crawl
```

:canonical: archivebox.api.v1_crawls.patch_crawl

```{autodoc2-docstring} archivebox.api.v1_crawls.patch_crawl
```

:canonical: archivebox.api.v1_crawls.delete_crawl

```{autodoc2-docstring} archivebox.api.v1_crawls.delete_crawl
```