Getting started

Make your first request to the FUTO Home API

1. Sign in

Sign in with your FUTO Home username and password. The response holds an accessToken for this session.

curl -X POST https://<server>/api/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"username": "<username>", "password": "<password>"}'

2. Create an API key

Use the session to create an API key. Keys can be scoped to fine grained permissions; the easiest start is the Permission: all permission. The response returns the key's secret once.

curl -X POST https://<server>/api/api-keys \
  -H 'Authorization: Bearer <accessToken>' \
  -H 'Content-Type: application/json' \
  -d '{"name": "my-script", "permissions": ["all"]}'

3. Call the API

Send the secret in the x-api-key header.

curl https://<server>/api/users/me -H 'x-api-key: <secret>'

4. Explore!

Browse the Endpoints and Models to see what else you can do.

Next Steps

Learn about Authentication Learn about Permissions