This feature requires the djangorestframework library to be installed. Starting with Tethys 5.0 or if you are using micro-tethys-platform, you will need to install djangorestframework using conda or pip as follows:

# conda: conda-forge channel strongly recommended
conda install -c conda-forge djangorestframework

# pip
pip install djangorestframework

Don't Forget: If you end up using this feature in your app, add djangorestframework as a requirement to your install.yml.

REST API's in Tethys Platform use token authentication (see:

You can find the API token for your user on the user management page (http://[HOST_Portal]/user/[username]/).

Example API Controller (

from django.http import JsonResponse
from rest_framework.authentication import TokenAuthentication
from rest_framework.decorators import api_view, authentication_classes
from tethys_sdk.routing import controller

@api_view(['GET', 'POST'])
def get_time_series(request):
    Controller for the get-time-series REST endpoint.
    name = request.GET.get('name', None)
    response_data = {'name': name}
    return JsonResponse(response_data)

Example Accessing Data:

>>> import requests
>>> res = requests.get('http://[HOST_Portal]/apps/[your_app_name]/api/get-data?name=oscar',
                       headers={'Authorization': 'Token asdfqwer1234'})
>>> da.text
'{"name": "oscar"}'