Files
nhost/docs/docs.json

756 lines
33 KiB
JSON

{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Documentation",
"integrations": {
"segment": {
"key": "kD6QfDOMGR2IoJ9D1U1H5Q9X7AEjoVfN"
}
},
"colors": {
"primary": "#3787ff",
"light": "#569aff",
"dark": "#1874ff"
},
"favicon": "/favicon.svg",
"navigation": {
"tabs": [
{
"tab": "Welcome",
"pages": [
"welcome"
]
},
{
"tab": "Getting Started",
"pages": [
{
"group": "Welcome",
"icon": "house",
"pages": ["/getting-started/overview" ]
},
{
"group": "Quickstart",
"icon": "house",
"pages": [
"/getting-started/quickstart/react",
"/getting-started/quickstart/nextjs",
"/getting-started/quickstart/vue",
"/getting-started/quickstart/sveltekit",
"/getting-started/quickstart/reactnative"
]
},
{
"group": "Tutorial: ToDo App (React)",
"icon": "react",
"pages": [
"/getting-started/tutorials/react/1-introduction",
"/getting-started/tutorials/react/2-protected-routes",
"/getting-started/tutorials/react/3-user-authentication",
"/getting-started/tutorials/react/4-graphql-operations",
"/getting-started/tutorials/react/5-file-uploads"
]
},
{
"group": "Tutorial: ToDo App (Next.js)",
"icon": "triangle",
"pages": [
"/getting-started/tutorials/nextjs/1-introduction",
"/getting-started/tutorials/nextjs/2-protected-routes",
"/getting-started/tutorials/nextjs/3-user-authentication",
"/getting-started/tutorials/nextjs/4-graphql-operations",
"/getting-started/tutorials/nextjs/5-file-uploads"
]
},
{
"group": "Tutorial: ToDo App (Vue)",
"icon": "vuejs",
"pages": [
"/getting-started/tutorials/vue/1-introduction",
"/getting-started/tutorials/vue/2-protected-routes",
"/getting-started/tutorials/vue/3-user-authentication",
"/getting-started/tutorials/vue/4-graphql-operations",
"/getting-started/tutorials/vue/5-file-uploads"
]
},
{
"group": "Tutorial: ToDo App (Svelte)",
"icon": "s",
"pages": [
"/getting-started/tutorials/svelte/1-introduction",
"/getting-started/tutorials/svelte/2-protected-routes",
"/getting-started/tutorials/svelte/3-user-authentication",
"/getting-started/tutorials/svelte/4-graphql-operations",
"/getting-started/tutorials/svelte/5-file-uploads"
]
},
{
"group": "Tutorial: ToDo App (React Native)",
"icon": "mobile-notch",
"pages": [
"/getting-started/tutorials/reactnative/1-introduction",
"/getting-started/tutorials/reactnative/2-protected-routes",
"/getting-started/tutorials/reactnative/3-user-authentication",
"/getting-started/tutorials/reactnative/4-graphql-operations",
"/getting-started/tutorials/reactnative/5-file-uploads",
"/getting-started/tutorials/reactnative/6-sign-in-with-apple"
]
}
]
},
{
"tab": "Products",
"dropdowns": [
{
"dropdown": "Overview",
"icon": "eye",
"pages": [
"/products/overview"
]
},
{
"dropdown": "Auth",
"icon": "lock",
"pages": [
"/products/auth/overview",
"/products/auth/users",
"/products/auth/client_and_redirect_urls",
"/products/auth/jwt",
"/products/auth/email-templates",
"/products/auth/gravatar",
{
"group": "Sign In Methods",
"pages": [
{
"group": "Providers",
"icon": "at",
"pages": [
"products/auth/providers/overview",
"products/auth/providers/sign-in-provider",
"products/auth/providers/tokens",
"products/auth/providers/connect",
"products/auth/providers/idtokens",
{
"group": "Configuration",
"icon": "gear",
"pages": [
"products/auth/providers/sign-in-apple",
"products/auth/providers/sign-in-azuread",
"products/auth/providers/sign-in-discord",
"products/auth/providers/sign-in-entraid",
"products/auth/providers/sign-in-facebook",
"products/auth/providers/sign-in-github",
"products/auth/providers/sign-in-google",
"products/auth/providers/sign-in-linkedin",
"products/auth/providers/sign-in-spotify",
"products/auth/providers/sign-in-twitch",
"products/auth/providers/sign-in-workos"
]
}
]
},
"/products/auth/sign-in-email-password",
"/products/auth/sign-in-otp",
"/products/auth/sign-in-magic-link",
"/products/auth/sign-in-sms-otp",
"/products/auth/webauthn"
]
},
{
"group": "Workflows",
"icon": "diagram-project",
"pages": [
"/products/auth/workflows/email-password",
"/products/auth/workflows/passwordless-email",
"/products/auth/workflows/passwordless-sms",
"/products/auth/workflows/webauthn",
"/products/auth/workflows/anonymous-users",
"/products/auth/workflows/change-email",
"/products/auth/workflows/change-password",
"/products/auth/workflows/reset-password",
"/products/auth/workflows/refresh-token"
]
},
{
"group": "Security",
"icon": "shield",
"pages": [
"/products/auth/elevated-permissions",
"/products/auth/bot-protection",
"/products/auth/custom-jwts",
"/products/auth/restricting_emails_and_domains"
]
}
]
},
{
"dropdown": "Database",
"icon":"database",
"pages":[
"/products/database/overview",
"/products/database/configuring-postgres",
"/products/database/backups",
"/products/database/access",
"/products/database/extensions",
"/products/database/performance",
"/products/database/upgrade-major"
]
},
{
"dropdown": "Functions",
"icon":"lambda",
"pages":[
"/products/functions/overview",
"/products/functions/getting-started",
"/products/functions/runtimes"
]
},
{
"dropdown": "GraphQL",
"icon":"webhook",
"pages":[
"/products/graphql/overview",
"/products/graphql/configuring-hasura",
"/products/graphql/permissions",
"/products/graphql/advanced-features",
{
"group": "Guides",
"icon": "book",
"pages": [
"/products/graphql/guides/react-apollo",
"/products/graphql/guides/react-query",
"/products/graphql/guides/react-urql"
]
}
]
},
{
"dropdown": "Storage",
"icon":"warehouse",
"pages":[
"/products/storage/overview",
"/products/storage/cdn",
"/products/storage/antivirus"
]
},
{
"dropdown": "AI",
"icon":"robot",
"pages":[
"/products/ai/overview",
"/products/ai/enabling-service",
"/products/ai/local-development",
"/products/ai/auto-embeddings",
"/products/ai/assistants",
"/products/ai/dev-assistant"
]
},
{
"dropdown": "Run",
"icon":"play",
"pages":[
"/products/run/overview",
"/products/run/getting-started",
"/products/run/configuration",
"/products/run/networking",
"/products/run/health-checks",
"/products/run/resources",
"/products/run/registry",
"/products/run/local-development",
"/products/run/configuration-overlays",
"/products/run/cli-deployments"
]
}
]
},
{
"tab": "Platform",
"dropdowns": [
{
"dropdown": "Overview",
"icon": "eye",
"pages": [
"/platform/overview"
]
},
{
"dropdown": "Cloud",
"icon": "cloud",
"pages": [
"/platform/cloud/overview",
"platform/cloud/subdomain",
"platform/cloud/compute-resources",
"platform/cloud/service-replicas",
"platform/cloud/metrics",
"platform/cloud/environment-variables",
"platform/cloud/secrets",
"platform/cloud/git",
"platform/cloud/custom-domains",
"platform/cloud/rate-limits",
"platform/cloud/tls",
"platform/cloud/billing"
]
},
{
"dropdown": "Development",
"icon": "terminal",
"pages": [
"/platform/cli/overview",
"/platform/cli/local-development",
"/platform/cli/cloud-development",
"/platform/cli/subdomain",
"/platform/cli/migrate-config",
"/platform/cli/multiple-projects",
"/platform/cli/configuration-overlays",
"/platform/cli/seeds",
{
"group": "MCP Server",
"icon": "brain",
"pages": [
"/platform/cli/mcp/overview",
"/platform/cli/mcp/configuration",
"/platform/cli/mcp/clients",
"/platform/cli/mcp/troubleshooting"
]
}
]
},
{
"dropdown": "Self-Hosting",
"icon": "server",
"pages": [
"/platform/self-hosting/overview",
"/platform/self-hosting/community",
"/platform/self-hosting/support",
"/platform/self-hosting/dedicated"
]
}
]
},
{
"tab":"Reference",
"icon":"bolt",
"pages":[
"/reference/overview",
{
"group": "Backend Services",
"pages": [
{
"group": "Authentication",
"icon": "user-check",
"pages": [
"reference/auth/get--well-known-jwks-json",
"reference/auth/post-elevate-webauthn",
"reference/auth/post-elevate-webauthn-verify",
"reference/auth/head-healthz",
"reference/auth/get-healthz",
"reference/auth/post-link-idtoken",
"reference/auth/get-mfa-totp-generate",
"reference/auth/post-pat",
"reference/auth/post-signin-anonymous",
"reference/auth/post-signin-email-password",
"reference/auth/post-signin-idtoken",
"reference/auth/post-signin-mfa-totp",
"reference/auth/post-signin-otp-email",
"reference/auth/post-signin-otp-email-verify",
"reference/auth/post-signin-passwordless-email",
"reference/auth/post-signin-passwordless-sms",
"reference/auth/post-signin-passwordless-sms-otp",
"reference/auth/post-signin-pat",
"reference/auth/get-signin-provider-{provider}",
"reference/auth/get-signin-provider-{provider}-callback",
"reference/auth/get-signin-provider-{provider}-callback-tokens",
"reference/auth/post-signin-provider-{provider}-callback",
"reference/auth/post-signin-webauthn",
"reference/auth/post-signin-webauthn-verify",
"reference/auth/post-signout",
"reference/auth/post-signup-email-password",
"reference/auth/post-signup-webauthn",
"reference/auth/post-signup-webauthn-verify",
"reference/auth/post-token",
"reference/auth/post-token-provider-{provider}",
"reference/auth/post-token-verify",
"reference/auth/get-user",
"reference/auth/post-user-deanonymize",
"reference/auth/post-user-email-change",
"reference/auth/post-user-email-send-verification-email",
"reference/auth/post-user-mfa",
"reference/auth/post-user-password",
"reference/auth/post-user-password-reset",
"reference/auth/post-user-webauthn-add",
"reference/auth/post-user-webauthn-verify",
"reference/auth/get-verify",
"reference/auth/get-version"
]
},
{
"group": "Storage",
"icon": "warehouse",
"pages": [
"reference/storage/post-files",
"reference/storage/head-files-{id}",
"reference/storage/get-files-{id}",
"reference/storage/delete-files-{id}",
"reference/storage/put-files-{id}",
"reference/storage/get-files-{id}-presignedurl",
"reference/storage/get-files-{id}-presignedurl-contents",
"reference/storage/get-openapi-yaml",
"reference/storage/post-ops-delete-broken-metadata",
"reference/storage/post-ops-delete-orphans",
"reference/storage/post-ops-list-broken-metadata",
"reference/storage/post-ops-list-not-uploaded",
"reference/storage/post-ops-list-orphans",
"reference/storage/get-version"
]
},
{
"group": "AI",
"icon":"robot",
"pages": [
"reference/graphql/ai/overview",
{
"group": "Query",
"pages": [
"reference/graphql/ai/query/assistant",
"reference/graphql/ai/query/assistants",
"reference/graphql/ai/query/session",
"reference/graphql/ai/query/sessionMessages",
"reference/graphql/ai/query/sessions"
]
},
{
"group": "Mutation",
"pages": [
"reference/graphql/ai/mutation/insertAssistant",
"reference/graphql/ai/mutation/updateAssistant",
"reference/graphql/ai/mutation/deleteAssistant",
"reference/graphql/ai/mutation/startSession",
"reference/graphql/ai/mutation/deleteSession",
"reference/graphql/ai/mutation/sendMessage",
"reference/graphql/ai/mutation/startDevSession",
"reference/graphql/ai/mutation/sendDevMessage"
]
}
]
}
]
},
{
"group": "Client Libraries",
"pages": [
{
"group": "Javascript",
"icon": "js",
"pages": [
{
"group": "nhost-js",
"pages": [
"reference/javascript/nhost-js/main",
"reference/javascript/nhost-js/auth",
"reference/javascript/nhost-js/functions",
"reference/javascript/nhost-js/graphql",
"reference/javascript/nhost-js/storage",
"reference/javascript/nhost-js/session",
"reference/javascript/nhost-js/fetch"
]
}
]
}
]
},
{
"group": "Client Libraries (deprecated)",
"pages": [
{
"group": "Javascript",
"icon":"js",
"pages": [
{
"group": "nhost-js",
"pages": [
"reference/deprecated/javascript/nhost-js/nhost-client",
"reference/deprecated/javascript/nhost-js/set-role",
"reference/deprecated/javascript/nhost-js/unset-role"
]
},
{
"group": "Auth",
"pages": [
"reference/deprecated/javascript/auth/hasura-auth-client",
"reference/deprecated/javascript/auth/change-email",
"reference/deprecated/javascript/auth/change-password",
"reference/deprecated/javascript/auth/create-pat",
"reference/deprecated/javascript/auth/get-access-token",
"reference/deprecated/javascript/auth/get-authentication-status",
"reference/deprecated/javascript/auth/get-decoded-access-token",
"reference/deprecated/javascript/auth/get-hasura-claim",
"reference/deprecated/javascript/auth/get-hasura-claims",
"reference/deprecated/javascript/auth/get-session",
"reference/deprecated/javascript/auth/get-user",
"reference/deprecated/javascript/auth/is-authenticated",
"reference/deprecated/javascript/auth/is-authenticated-async",
"reference/deprecated/javascript/auth/on-auth-state-changed",
"reference/deprecated/javascript/auth/on-token-changed",
"reference/deprecated/javascript/auth/refresh-session",
"reference/deprecated/javascript/auth/reset-password",
"reference/deprecated/javascript/auth/send-verification-email",
"reference/deprecated/javascript/auth/sign-in",
"reference/deprecated/javascript/auth/sign-in-pat",
"reference/deprecated/javascript/auth/sign-out",
"reference/deprecated/javascript/auth/sign-up",
"reference/deprecated/javascript/auth/add-security-key",
"reference/deprecated/javascript/auth/elevate-email-security-key",
"reference/deprecated/javascript/auth/connect-provider",
"reference/deprecated/javascript/auth/sign-in-email-otp",
"reference/deprecated/javascript/auth/verify-email-otp",
"reference/deprecated/javascript/auth/sign-in-id-token",
"reference/deprecated/javascript/auth/link-id-token",
"reference/deprecated/javascript/auth/sign-in-security-key"
]
},
{
"group": "Storage",
"pages": [
"reference/deprecated/javascript/storage/hasura-storage-client",
"reference/deprecated/javascript/storage/upload",
"reference/deprecated/javascript/storage/download",
"reference/deprecated/javascript/storage/get-presigned-url",
"reference/deprecated/javascript/storage/get-public-url",
"reference/deprecated/javascript/storage/delete",
"reference/deprecated/javascript/storage/set-access-token",
"reference/deprecated/javascript/storage/set-admin-secret",
"reference/deprecated/javascript/storage/set-headers",
"reference/deprecated/javascript/storage/unset-headers",
"reference/deprecated/javascript/storage/get-headers"
]
},
{
"group": "GraphQL ",
"pages": [
"reference/deprecated/javascript/graphql/nhost-graphql-client",
"reference/deprecated/javascript/graphql/get-url",
"reference/deprecated/javascript/graphql/set-access-token",
"reference/deprecated/javascript/graphql/request",
"reference/deprecated/javascript/graphql/set-headers",
"reference/deprecated/javascript/graphql/unset-headers",
"reference/deprecated/javascript/graphql/get-headers"
]
},
{
"group": "Functions ",
"pages": [
"reference/deprecated/javascript/functions/create-functions-client",
"reference/deprecated/javascript/functions/call",
"reference/deprecated/javascript/functions/set-access-token"
]
}
]
},
{
"group": "React",
"icon": "react",
"pages": [
"reference/deprecated/react/nhost-client",
"reference/deprecated/react/signed-in",
"reference/deprecated/react/signed-out",
"reference/deprecated/react/use-access-token",
"reference/deprecated/react/use-add-security-key",
"reference/deprecated/react/use-authenticated",
"reference/deprecated/react/use-authentication-status",
"reference/deprecated/react/use-change-email",
"reference/deprecated/react/use-change-password",
"reference/deprecated/react/use-config-mfa",
"reference/deprecated/react/use-decoded-access-token",
"reference/deprecated/react/use-file-upload",
"reference/deprecated/react/use-file-upload-item",
"reference/deprecated/react/use-hasura-claim",
"reference/deprecated/react/use-hasura-claims",
"reference/deprecated/react/use-multiple-files-upload",
"reference/deprecated/react/use-nhost-client",
"reference/deprecated/react/use-provider-link",
"reference/deprecated/react/use-reset-password",
"reference/deprecated/react/use-send-verification-email",
"reference/deprecated/react/use-sign-in-anonymous",
"reference/deprecated/react/use-sign-in-email-password",
"reference/deprecated/react/use-sign-in-email-passwordless",
"reference/deprecated/react/use-sign-in-email-security-key",
"reference/deprecated/react/use-sign-in-pat",
"reference/deprecated/react/use-sign-in-sms-passwordless",
"reference/deprecated/react/use-sign-out",
"reference/deprecated/react/use-sign-up-email-password",
"reference/deprecated/react/use-sign-up-email-security-key-email",
"reference/deprecated/react/use-elevate-security-key-email",
"reference/deprecated/react/use-user-avatar-url",
"reference/deprecated/react/use-user-data",
"reference/deprecated/react/use-user-default-role",
"reference/deprecated/react/use-user-display-name",
"reference/deprecated/react/use-user-email",
"reference/deprecated/react/use-user-id",
"reference/deprecated/react/use-user-is-anonymous",
"reference/deprecated/react/use-user-locale",
"reference/deprecated/react/use-user-roles",
"reference/deprecated/react/use-sign-in-email-otp",
"reference/deprecated/react/use-sign-in-id-token",
"reference/deprecated/react/use-link-id-token",
"reference/deprecated/react/use-sign-in-security-key"
]
},
{
"group": "Next.js",
"icon": "react",
"pages": [
"reference/deprecated/nextjs/nhost-client",
"reference/deprecated/nextjs/signed-in",
"reference/deprecated/nextjs/signed-out",
"reference/deprecated/nextjs/create-server-side-client",
"reference/deprecated/nextjs/get-nhost-session",
"reference/deprecated/nextjs/use-access-token",
"reference/deprecated/nextjs/use-add-security-key",
"reference/deprecated/nextjs/use-authenticated",
"reference/deprecated/nextjs/use-authentication-status",
"reference/deprecated/nextjs/use-change-email",
"reference/deprecated/nextjs/use-change-password",
"reference/deprecated/nextjs/use-config-mfa",
"reference/deprecated/nextjs/use-decoded-access-token",
"reference/deprecated/nextjs/use-file-upload",
"reference/deprecated/nextjs/use-file-upload-item",
"reference/deprecated/nextjs/use-hasura-claim",
"reference/deprecated/nextjs/use-hasura-claims",
"reference/deprecated/nextjs/use-multiple-files-upload",
"reference/deprecated/nextjs/use-nhost-client",
"reference/deprecated/nextjs/use-provider-link",
"reference/deprecated/nextjs/use-reset-password",
"reference/deprecated/nextjs/use-send-verification-email",
"reference/deprecated/nextjs/use-sign-in-anonymous",
"reference/deprecated/nextjs/use-sign-in-email-password",
"reference/deprecated/nextjs/use-sign-in-email-passwordless",
"reference/deprecated/nextjs/use-sign-in-email-security-key",
"reference/deprecated/nextjs/use-sign-in-pat",
"reference/deprecated/nextjs/use-sign-in-sms-passwordless",
"reference/deprecated/nextjs/use-sign-out",
"reference/deprecated/nextjs/use-sign-up-email-password",
"reference/deprecated/nextjs/use-sign-up-email-security-key-email",
"reference/deprecated/nextjs/use-elevate-security-key-email",
"reference/deprecated/nextjs/use-user-avatar-url",
"reference/deprecated/nextjs/use-user-data",
"reference/deprecated/nextjs/use-user-default-role",
"reference/deprecated/nextjs/use-user-display-name",
"reference/deprecated/nextjs/use-user-email",
"reference/deprecated/nextjs/use-user-id",
"reference/deprecated/nextjs/use-user-is-anonymous",
"reference/deprecated/nextjs/use-user-locale",
"reference/deprecated/nextjs/use-user-roles",
"reference/deprecated/nextjs/use-sign-in-email-otp",
"reference/deprecated/nextjs/use-sign-in-id-token",
"reference/deprecated/nextjs/use-link-id-token",
"reference/deprecated/nextjs/use-sign-in-security-key"
]
},
{
"group": "Vue",
"icon": "vuejs",
"pages": [
"reference/deprecated/vue/nhost-client",
"reference/deprecated/vue/use-access-token",
"reference/deprecated/vue/use-authenticated",
"reference/deprecated/vue/use-authentication-status",
"reference/deprecated/vue/use-change-email",
"reference/deprecated/vue/use-change-password",
"reference/deprecated/vue/use-decoded-access-token",
"reference/deprecated/vue/use-file-upload",
"reference/deprecated/vue/use-file-upload-item",
"reference/deprecated/vue/use-hasura-claim",
"reference/deprecated/vue/use-hasura-claims",
"reference/deprecated/vue/use-multiple-files-upload",
"reference/deprecated/vue/use-nhost-client",
"reference/deprecated/vue/use-provider-link",
"reference/deprecated/vue/use-reset-password",
"reference/deprecated/vue/use-send-verification-email",
"reference/deprecated/vue/use-sign-in-anonymous",
"reference/deprecated/vue/use-sign-in-email-password",
"reference/deprecated/vue/use-sign-in-email-passwordless",
"reference/deprecated/vue/use-sign-in-pat",
"reference/deprecated/vue/use-sign-in-sms-passwordless",
"reference/deprecated/vue/use-sign-out",
"reference/deprecated/vue/use-sign-up-email-password",
"reference/deprecated/vue/use-user-avatar-url",
"reference/deprecated/vue/use-user-data",
"reference/deprecated/vue/use-user-default-role",
"reference/deprecated/vue/use-user-display-name",
"reference/deprecated/vue/use-user-email",
"reference/deprecated/vue/use-user-id",
"reference/deprecated/vue/use-user-is-anonymous",
"reference/deprecated/vue/use-user-locale",
"reference/deprecated/vue/use-user-roles",
"reference/deprecated/vue/use-add-security-key",
"reference/deprecated/vue/use-elevate-security-key-email",
"reference/deprecated/vue/use-sign-in-email-security-key",
"reference/deprecated/vue/use-sign-up-email-security-key",
"reference/deprecated/vue/use-sign-in-email-otp",
"reference/deprecated/vue/use-sign-in-id-token",
"reference/deprecated/vue/use-link-id-token",
"reference/deprecated/vue/use-sign-in-security-key"
]
},
{
"group": "React Native",
"icon": "mobile-notch",
"pages": ["reference/deprecated/react-native/support"]
}
]
},
{
"group": "CLI",
"pages": [
"reference/cli/commands"
]
}
]
},
{
"tab": "Blog",
"href":"https://nhost.io/blog"
}
]
},
"redirects": [
{
"source": "/products/auth/social/:slug*",
"destination": "/products/auth/providers/:slug*"
},
{
"source": "/products/auth/social-connect",
"destination": "products/auth/providers/connect"
},
{
"source": "/products/auth/idtokens",
"destination": "products/auth/providers/idtokens"
}
],
"logo": {
"light": "/images/logo/light.svg",
"dark": "/images/logo/dark.svg"
},
"navbar": {
"links": [
{
"label": "Support",
"href": "https://app.nhost.io/support"
}
],
"primary": {
"type": "button",
"label": "Dashboard",
"href": "https://app.nhost.io"
}
},
"footer": {
"socials": {
"twitter": "https://twitter.com/nhost",
"github": "https://github.com/nhost",
"linkedin": "https://www.linkedin.com/company/nhost"
}
}
}