Utils
Coolify API
Leverage the Coolify API to create, control and manage all your Coolify products over API.
Coolify API Token Guide
Usage
To reach the internal Coolify API endpoints within the module, you can create yor endpoint in Nitro and then simply use our built-in server utils.
Back end Nitro Example
Create a new endpoint and name it e.g. /server/api/v1/coolify/instances:
List all instances
export default defineEventHandler(async (_event) => {
// check auth permissions
return useCoolify().instances()
})
List all for a specific Coolify instance
~/server/api/v1/coolify/instances/[name
import type { Instance } from 'nuxt-coolify'
export default defineEventHandler(async (event) => {
const name = getRouterParam(event, 'name')
const { instances } = useRuntimeConfig().coolify
if (name && !Object.prototype.hasOwnProperty.call(instances, name)) {
return createError({
statusCode: 500,
message: 'Provided Instance is not configured.',
})
}
// check auth permissions
return useCoolify().instances(name as Instance)
})
Nuxt Example using useFetch()
<script setup lang="ts">
const { data: instances, status: cStatus, error: cError, refresh: refreshInstanceList } = useFetch('/api/_v1/_coolify/instances')
const { data: serverList, status: hStatus, error: hError, refresh: refreshServerList } = useFetch('/api/_v1/_hetzner/servers')
</script>
Helper list
Coming soon, for now you can check the source code of the module to see all the available helpers.