✈️API

Inuva is not meant to be ran 24/7. It will sleep when it detects 30 minutes of inactivity. For automation this is a dealbreaker so that's why there's an API.

For this to work you probably want an API key. You can request an API key by sending an email to laurens@inuva.me or sending a message in Discord (there will be a user interface for this in the future)

Boot

This wakes the instance up from sleep or boots it when it's in a shut down state.

curl -H 'Authorization: Bearer <api_key>' -X POST https://inuva.me/api/instance/boot

This will return the following

  • 422: User does not have an instance

  • 401: Unauthenticated

  • 202: Accepted

Reset

This tries to reset the machine when it's stuck in a bad state. After the reset it will reboot the instance.

curl -H 'Authorization: Bearer <api_key>' -X POST https://inuva.me/api/instance/reset

This will return the following

  • 422: User does not have an instance

  • 401: Unauthenticated

  • 202: Accepted

Shutdown

This shuts the instance down.

Under normal circumstances you do not have to worry about shutting the machine down. It will hibernate automatically after 30 minutes idle.

curl -H 'Authorization: Bearer <api_key>' -X POST https://inuva.me/api/instance/shutdown

This will return the following

  • 422: User does not have an instance

  • 401: Unauthenticated

  • 202: Accepted

PreviousDevelopersNextTroubleshooting

Last updated