# Documentation

## Docs

- [Assign an Alias](https://docs.appz.dev/api-reference/endpoint/aliases/assign.md)
- [Delete an Alias](https://docs.appz.dev/api-reference/endpoint/aliases/delete.md)
- [Get an Alias](https://docs.appz.dev/api-reference/endpoint/aliases/get.md)
- [List Aliases](https://docs.appz.dev/api-reference/endpoint/aliases/list.md): Retrieves a list of aliases for the authenticated User or Team. When domain is provided, only aliases for that domain will be returned. When projectId is provided, it will only return the given project aliases.
- [Login with email](https://docs.appz.dev/api-reference/endpoint/auth/email-login.md): Request a new login for a user to get a token. This will respond with a verification token and send an email to confirm the request. Once confirmed you can use the verification token to get an authentication token.
- [Verify a login request to get an authentication token](https://docs.appz.dev/api-reference/endpoint/auth/verify.md): Verify the user accepted the login request and get a authentication token. The user email address and the token received after requesting the login must be added to the URL as a query string with the names email and token.
- [Delete a Domain](https://docs.appz.dev/api-reference/endpoint/domains/delete.md): Delete a previously registered domain name from Appz. Deleting a domain will automatically remove any associated aliases.
- [List domains](https://docs.appz.dev/api-reference/endpoint/domains/list.md): Retrieves a list of domains registered for the authenticated user or team. By default it returns the last 20 domains if no limit is provided.
- [Add a domain to a project](https://docs.appz.dev/api-reference/endpoint/projects/add-domain.md): Add a domain to the project by passing its domain name and by specifying the project by either passing the project id or name in the URL. If the domain is not yet verified to be used on this project, the request will return verified = false, and the domain will need to be verified according to the v…
- [Create a new Project](https://docs.appz.dev/api-reference/endpoint/projects/create.md): Allows to create a new project with the provided configuration. It only requires the project name but more configuration can be provided to override the defaults.
- [Delete a Project](https://docs.appz.dev/api-reference/endpoint/projects/delete.md): Delete a specific project by passing either the project id or name in the URL.
- [Find a project by id or name](https://docs.appz.dev/api-reference/endpoint/projects/get.md): Get the information for a specific project by passing either the project id or name in the URL.
- [Retrieve a list of projects](https://docs.appz.dev/api-reference/endpoint/projects/list.md): Allows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects.
- [Retrieve project domains by project by id or name](https://docs.appz.dev/api-reference/endpoint/projects/list-domains.md): Retrieve the domains associated with a given project by passing either the project id or name in the URL.
- [Update a Project](https://docs.appz.dev/api-reference/endpoint/projects/update.md): Update the fields of a project using either its name or id.
- [Create a Team](https://docs.appz.dev/api-reference/endpoint/teams/create.md)
- [Delete a Team](https://docs.appz.dev/api-reference/endpoint/teams/delete.md): Delete a team under your account. You need to send a DELETE request with the desired team id.
- [Get a Team](https://docs.appz.dev/api-reference/endpoint/teams/get.md): Get a paginated list of team members for the provided team.
- [Invite a user](https://docs.appz.dev/api-reference/endpoint/teams/invite.md): Invite a user to join the team specified in the URL. The authenticated user needs to be an `OWNER` in order to successfully invoke this endpoint. The user can be specified with an email or an ID. If both email and ID are provided, ID will take priority.
- [Join a team](https://docs.appz.dev/api-reference/endpoint/teams/join.md): Join a team with a provided invite code or team ID.
- [List Teams](https://docs.appz.dev/api-reference/endpoint/teams/list.md): Get a paginated list of all the Teams the authenticated User is a member of.
- [List team members](https://docs.appz.dev/api-reference/endpoint/teams/list-members.md): Get a paginated list of team members for the provided team.
- [Update a Team](https://docs.appz.dev/api-reference/endpoint/teams/update.md): Update the information of a Team specified by the teamId parameter. The request body should contain the information that will be updated on the Team.
- [Get the User](https://docs.appz.dev/api-reference/endpoint/users/get.md): Retrieves information related to the currently authenticated User.
- [Appz Rest Api](https://docs.appz.dev/api-reference/introduction.md): The Appz REST API is a REST-styled API that gives full control over the entire Appz platform.
- [appz alias](https://docs.appz.dev/cli/commands/alias.md): Learn how to apply custom domain aliases to your Appz deployments using the `appz alias` CLI command.
- [appz build](https://docs.appz.dev/cli/commands/build.md): Learn how to build an Appz Project locally or in your CI environment using the `appz build` CLI command.
- [appz deploy](https://docs.appz.dev/cli/commands/deploy.md): Learn how to deploy your Appz projects using the `appz deploy` CLI command.
- [appz dev](https://docs.appz.dev/cli/commands/dev.md): Learn how to mimic the Appz deployment environment locally and test your Appz Project before deploying using the `appz dev` CLI command.
- [appz domains](https://docs.appz.dev/cli/commands/domains.md): Learn how to buy, sell, transfer, and manage your domains using the `appz domains` CLI command.
- [appz info](https://docs.appz.dev/cli/commands/info.md)
- [appz init](https://docs.appz.dev/cli/commands/init.md): Learn how to initialize example Appz Projects locally using the `appz init` CLI command.
- [appz link](https://docs.appz.dev/cli/commands/link.md): Learn how to link a local directory to an Appz Project using the `appz link` CLI command.
- [appz list](https://docs.appz.dev/cli/commands/list.md): Learn how to list all recent deployments for the current Appz Project using the `appz list` CLI command.
- [appz login](https://docs.appz.dev/cli/commands/login.md)
- [appz logout](https://docs.appz.dev/cli/commands/logout.md): Learn how to logout from your Appz account using the `appz logout` CLI command
- [appz project](https://docs.appz.dev/cli/commands/project.md): Learn how to list, add, remove, and manage your Appz Projects using the `appz project` CLI command.
- [appz promote](https://docs.appz.dev/cli/commands/promote.md): Learn how to promote an existing deployment using the `appz promote` CLI command.
- [appz pull](https://docs.appz.dev/cli/commands/pull.md): Learn how to update your local project with remote environment variables using the appz pull CLI command.
- [appz remove](https://docs.appz.dev/cli/commands/remove.md): Learn how to remove a deployment using the `appz remove` CLI command, which can also be abbreviated as `appz rm`. This command is used to delete deployments by ID or associated with a specific Appz Project.
- [appz rollback](https://docs.appz.dev/cli/commands/rollback.md): Learn how to roll back your production deployments to previous deployments using the `appz rollback` CLI command.
- [appz setup](https://docs.appz.dev/cli/commands/setup.md)
- [appz switch](https://docs.appz.dev/cli/commands/switch.md): Learn how to switch between different team scopes using the `appz switch` CLI command.
- [appz teams](https://docs.appz.dev/cli/commands/teams.md): Learn how to list, add, remove, and manage your teams using the `appz teams` CLI command.
- [appz transfer](https://docs.appz.dev/cli/commands/transfer.md): Learn how to transfer a project between Appz accounts using the `appz transfer` CLI command.
- [appz upgrade](https://docs.appz.dev/cli/commands/upgrade.md)
- [Deploying Projects from Appz CLI](https://docs.appz.dev/cli/deploying.md): Learn how to deploy your Appz Projects from Appz CLI using the `appz` or `appz deploy` commands.
- [Appz CLI Global Options](https://docs.appz.dev/cli/global-options.md): Global options are commonly available to use with multiple Appz CLI commands. Learn about Appz CLI's global options here.
- [Appz CLI Overview](https://docs.appz.dev/cli/introduction.md)
- [Linking Projects with Appz CLI](https://docs.appz.dev/cli/project-linking.md): Learn how to link existing Appz Projects with Appz CLI.
- [Deploy a static Ghost site](https://docs.appz.dev/cms/ghost.md): Learn how to use Appz’s features with Hexo
- [Deploy a static WordPress site](https://docs.appz.dev/cms/wordpress.md): Learn how to use Appz’s features with Hexo
- [Notifications](https://docs.appz.dev/forms/features/notifications.md)
- [Redirection](https://docs.appz.dev/forms/features/redirection.md)
- [Forms Setup](https://docs.appz.dev/forms/setup/ajax.md)
- [File uploads](https://docs.appz.dev/forms/setup/file-uploads.md)
- [Forms Setup](https://docs.appz.dev/forms/setup/html-form.md)
- [Hcaptcha](https://docs.appz.dev/forms/spam-filtering/hcaptcha.md)
- [Honeypot](https://docs.appz.dev/forms/spam-filtering/honeypot.md)
- [Recaptcha v2](https://docs.appz.dev/forms/spam-filtering/recaptcha-v2.md)
- [Recaptcha v3](https://docs.appz.dev/forms/spam-filtering/recaptcha-v3.md)
- [Submissions](https://docs.appz.dev/forms/submissions.md)
- [Usage and billing](https://docs.appz.dev/forms/usage-and-billing.md)
- [Overview](https://docs.appz.dev/forms/webhooks/overview.md): Webhook plugins enable you to forward your form submission data to external destinations by configuring webhooks on your Appz form.
- [Setup](https://docs.appz.dev/forms/webhooks/setup.md)
- [Deploy a Eleventy Site](https://docs.appz.dev/frameworks/11ty.md): Learn how to use Appz’s features with Eleventy
- [Deploy a Astro Site](https://docs.appz.dev/frameworks/astro.md): Learn how to use Appz's features with Astro
- [Deploy a Docusaurus Site](https://docs.appz.dev/frameworks/docusaurus.md): Learn how to use Appz's features with Docusaurus
- [Deploy a Hexo Site](https://docs.appz.dev/frameworks/hexo.md): Learn how to use Appz’s features with Hexo
- [Deploy a Hugo Site](https://docs.appz.dev/frameworks/hugo.md): Learn how to use Appz’s features with Hugo
- [Deploy a Qwik Site](https://docs.appz.dev/frameworks/qwik.md): Learn how to use Appz’s features with Qwik
- [Deploy a Zola Site](https://docs.appz.dev/frameworks/zola.md): Learn how to use Appz’s features with Zola
- [Import an existing project](https://docs.appz.dev/get-started-with-appz/import.md): Create a new project on Appz by using a template
- [Projects and deployments](https://docs.appz.dev/get-started-with-appz/projects-deployments.md)
- [Use a Template](https://docs.appz.dev/get-started-with-appz/template.md): Create a new project on Appz by using a template
- [Use an existing domain](https://docs.appz.dev/get-started-with-appz/use-existing.md): Seamlessly integrate your existing domain with Appz. Maximize flexibility and maintain your established online presence.
- [Installing Appz Cli](https://docs.appz.dev/installation.md)
- [Introduction](https://docs.appz.dev/introduction.md): Appz Documentaion

## OpenAPI Specs

- [openapi](https://docs.appz.dev/api-reference/openapi.json)