# Getting started with WEKA REST API

The WEKA system provides a RESTful API, enabling you to automate interactions with the WEKA system and integrate them into your workflows or monitoring systems.

{% hint style="info" %}
It is essential to have a solid understanding of the WEKA CLI commands and parameters related to the REST API services.

For example, to create a filesystem using the `POST /fileSystems` service, see the related documentation in [#create-a-filesystem](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/managing-filesystems/managing-filesystems-1#create-a-filesystem "mention") (using the CLI).
{% endhint %}

## Access the REST API

You can access the REST API using one of the following methods:

{% tabs %}
{% tab title="Direct access" %}
Using port 14000 and the URL `/api/v2`.
{% endtab %}

{% tab title="Through the cluster" %}
By browsing to: `https://<cluster name>:14000/api/v2/docs`
{% endtab %}

{% tab title="Through the WEKA GUI" %}
Select the three dots on the upper right menu and select **REST API**.

<figure><img src="https://content.gitbook.com/content/lGKb8DZItQx3Jy6unw5f/blobs/mJdz5FQGm7nxRHlkZ7KR/wmng_access_rest_api.png" alt=""><figcaption><p>Access the REST API through the WEKA GUI</p></figcaption></figure>
{% endtab %}

{% tab title="WEKA static API" %}
Browse to [api.docs.weka.io](https://api.docs.weka.io) and select the REST API version from the definition selector.

In addition, you can create a client code using the OpenAPI client generator and the `.json` file.

<figure><img src="https://content.gitbook.com/content/lGKb8DZItQx3Jy6unw5f/blobs/p9WB86xCJtWJuJtC8xXl/static-api-docs.png" alt=""><figcaption><p>api.docs.weka.io</p></figcaption></figure>
{% endtab %}
{% endtabs %}

## Explore the REST API through the GUI

<figure><img src="https://content.gitbook.com/content/lGKb8DZItQx3Jy6unw5f/blobs/YsqoQK83FeWNVt1PkYiV/Get_started_with_REST_API.gif" alt=""><figcaption><p>Explore the REST API through the GUI</p></figcaption></figure>

## Obtain an access token

To use the WEKA REST API, provide an access or refresh token.

You can generate an access or refresh for the REST API usage through the CLI or the GUI.\
See [obtain-authentication-tokens](https://docs.weka.io/4.3/operation-guide/security/obtain-authentication-tokens "mention").

You can also call the login API to obtain access or refresh tokens through the API, providing it with a `username` and `password`.&#x20;

If you already obtained a refresh token, you can use the `login/refresh` API to refresh the access token.

{% tabs %}
{% tab title="Login" %}
{% code title="Python example calling the login API" %}

```python
import requests

url = "https://weka01:14000/api/v2/login"

payload="{\n    \"username\": \"admin\",\n    \"password\": \"admin\"\n}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

```

{% endcode %}
{% endtab %}

{% tab title="Refresh" %}
{% code title="Python example calling the login refresh API" %}

```python
import requests

url = "https://weka01:14000/api/v2/login/refresh"

payload="{\n    \"refresh_token\": \"REPLACE-WITH-REFRESH-TOKEN\"\n}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

```

{% endcode %}
{% endtab %}
{% endtabs %}

The response includes the access token (valid for 5 minutes) to use in the other APIs requiring token authentication, along with the refresh token (valid for 1 year), for getting additional access tokens without using the username/password.

{% code title="Login/Refresh Response" %}

```python
{
  "data": [
    {
      "access_token": "ACCESS-TOKEN",
      "token_type": "Bearer",
      "expires_in": 300,
      "refresh_token": "REFRESH-TOKEN"
    }
  ]
}
```

{% endcode %}

## Call the REST API

Once you obtain an access token, you can call WEKA REST API commands with it. For example, you can query the cluster status:

{% code title="Python example calling cluster status API" %}

```python
import requests

url = "https://weka01:14000/api/v2/cluster"

payload={}
headers = {
  'Authorization': 'Bearer REPLACE-WITH-ACCESS-TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

```

{% endcode %}

**Related topics**

[REST API Reference Guide](https://api.docs.weka.io/)