{py:mod}archivebox.api.v1_api

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`NinjaAPIWithIOCapture <archivebox.api.v1_api.NinjaAPIWithIOCapture>`
  -

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`register_urls <archivebox.api.v1_api.register_urls>`
  - ```{autodoc2-docstring} archivebox.api.v1_api.register_urls
    :summary:
    ```
* - {py:obj}`generic_exception_handler <archivebox.api.v1_api.generic_exception_handler>`
  - ```{autodoc2-docstring} archivebox.api.v1_api.generic_exception_handler
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`COMMIT_HASH <archivebox.api.v1_api.COMMIT_HASH>`
  - ```{autodoc2-docstring} archivebox.api.v1_api.COMMIT_HASH
    :summary:
    ```
* - {py:obj}`html_description <archivebox.api.v1_api.html_description>`
  - ```{autodoc2-docstring} archivebox.api.v1_api.html_description
    :summary:
    ```
* - {py:obj}`api <archivebox.api.v1_api.api>`
  - ```{autodoc2-docstring} archivebox.api.v1_api.api
    :summary:
    ```
* - {py:obj}`urls <archivebox.api.v1_api.urls>`
  - ```{autodoc2-docstring} archivebox.api.v1_api.urls
    :summary:
    ```

API

:canonical: archivebox.api.v1_api.COMMIT_HASH
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_api.COMMIT_HASH
```

:canonical: archivebox.api.v1_api.html_description
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_api.html_description
```

:canonical: archivebox.api.v1_api.register_urls

```{autodoc2-docstring} archivebox.api.v1_api.register_urls
```

:canonical: archivebox.api.v1_api.NinjaAPIWithIOCapture

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

````{py:method} create_temporal_response(request: django.http.HttpRequest) -> django.http.HttpResponse
:canonical: archivebox.api.v1_api.NinjaAPIWithIOCapture.create_temporal_response

```{autodoc2-docstring} archivebox.api.v1_api.NinjaAPIWithIOCapture.create_temporal_response
```

````

:canonical: archivebox.api.v1_api.api
:value: >
   'NinjaAPIWithIOCapture(...)'

```{autodoc2-docstring} archivebox.api.v1_api.api
```

:canonical: archivebox.api.v1_api.urls
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_api.urls
```

:canonical: archivebox.api.v1_api.generic_exception_handler

```{autodoc2-docstring} archivebox.api.v1_api.generic_exception_handler
```