# LAA REST API

```{admonition} LAA v1.4
:class: warning
The REST API is only available in LAA v1.4 and after.
```

The appliance provide a REST API to access to most of the features.

## Specifications

The OpenAPI specifications are provided by each LAA at [API
doc](http://laa.local/api/v1/docs).

The LAA API allows to query the software configuration of the LAA and also to
remotely execute [laacli](/software/laacli.md) commands on behalf of the caller.

```{mermaid}
:caption: laam, LAA and laacli
:align: center
sequenceDiagram
    laam->LAA: HTTP call on /api/v1/...
    Note right of LAA: Updating LAA SW state
    LAA-->laam: json

    laam->LAA: HTTP POST on /api/v1/laacli/...
    LAA->laacli: Local execution
    Note right of laacli: Updating LAA HW state<br>Calling laacli
    laacli-->LAA: Return value and outputs
    LAA-->laam: json
```

## Authentication

In order to use the REST API, the user should create an API token in the
appliance web interface.

Visit the [profile page](http://laa.local/profile/) and click on the `Add token` button.

![Profile page](/_images/software/api/profile.png){align=center}

The appliance will create a token and refresh the page. The token can be retrieved by clicking on `View token`.

![Token](/_images/software/api/token.png){align=center}

This token will be used by [laam](/software/laam.md) to interact with the REST API.