mirror of
https://github.com/n8n-io/n8n-docs.git
synced 2025-11-20 17:48:34 +00:00
51 lines
1.0 KiB
Markdown
51 lines
1.0 KiB
Markdown
---
|
|
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
|
|
template: api.html
|
|
hide:
|
|
- toc
|
|
- navigation
|
|
- feedback
|
|
- kapaButton
|
|
description: API reference for n8n's public REST API.
|
|
contentType: reference
|
|
---
|
|
|
|
|
|
<!-- Mount point -->
|
|
<div id="app"></div>
|
|
|
|
<!-- Load the Script -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
|
|
|
|
<!-- Initialize the Scalar API Reference -->
|
|
<script>
|
|
Scalar.createApiReference('#app', {
|
|
url: '/api/v1/openapi.yml',
|
|
// Avoid CORS issues
|
|
proxyUrl: 'https://proxy.scalar.com',
|
|
servers: [
|
|
{
|
|
url: 'https://{instance}.app.n8n.cloud/api/v1',
|
|
description: 'n8n cloud instance',
|
|
variables: {
|
|
instance: {
|
|
default: 'your-instance-name',
|
|
}
|
|
}
|
|
},
|
|
{
|
|
url: '{url}/api/v1',
|
|
description: 'self-hosted n8n instance',
|
|
variables: {
|
|
url: {
|
|
default: 'https://example.com',
|
|
}
|
|
}
|
|
},
|
|
],
|
|
forceDarkModeState: 'light',
|
|
hideDarkModeToggle: true,
|
|
hideClientButton: true,
|
|
})
|
|
</script>
|