Skip to main content

API tokens

info

💰 Feature available with subscription to Yucca Plus or Yucca Enterprise

Overview​

We provide a programmatic interface to all Yucca server resources. API documentation is available in SwaggerUI format on any installation at http://<your address>/ui/swagger/. You can authorize with a token by passing it in the X-Yucca-Token header, the token cookie, or the token request argument. With a personal API token you can manage any resources available to your user, except content (watching video) and the user interface.

Quick start​

Go to the user profile, the Tokens tab, and create a token for the desired period or without expiration. Save the token, as you won't be able to view it again.

PersonalTokens

cURL example​

curl -X 'GET' \
  'https://demo.yucca.app/v1/annotations?all=true' \
  -H 'accept: application/json' \
  -H 'X-Yucca-Token: p.bb42c69e83915664cae70e442a349eab509890d21'

SwaggerUI example​