# Restate Documentation

> Restate is a Durable Execution Engine for building resilient applications with ease.

- [Restate Documentation](https://docs.restate.dev/.md)

## adminapi

- [Admin API](https://docs.restate.dev/adminapi/admin-api.md): This API exposes the admin operations of a Restate cluster, such as registering new service deployments, interacting with running invocations, register Kafka subscriptions, retrieve service metadata. For an overview, check out the [Operate documentation](https://docs.restate.dev/operate/). If you're looking for how to call your services, check out the [Ingress HTTP API](https://docs.restate.dev/invoke/http) instead.
- [Cancel an invocation](https://docs.restate.dev/adminapi/cancel-invocation.md): Cancel the given invocation. Canceling an invocation allows it to free any resources it is holding and roll back any changes it has made so far, running compensation code. For more details, checkout https://docs.restate.dev/guides/sagas
- [Cluster health](https://docs.restate.dev/adminapi/cluster-health.md): Get the cluster health.
- [Cluster health](https://docs.restate.dev/adminapi/cluster-health.md): Get the cluster health.
- [Create deployment](https://docs.restate.dev/adminapi/create-deployment.md): Create deployment. Restate will invoke the endpoint to gather additional information required for registration, such as the services exposed by the deployment. If the deployment is already registered, this method will fail unless `force` is set to `true`.
- [Create subscription](https://docs.restate.dev/adminapi/create-subscription.md): Create subscription.
- [Delete deployment](https://docs.restate.dev/adminapi/delete-deployment.md): Delete deployment. Currently it's supported to remove a deployment only using the force flag
- [Delete an invocation](https://docs.restate.dev/adminapi/delete-invocation.md): Use kill_invocation/cancel_invocation/purge_invocation instead.
- [Delete subscription](https://docs.restate.dev/adminapi/delete-subscription.md): Delete subscription.
- [deployment](https://docs.restate.dev/adminapi/deployment.md): deployment
- [Get deployment](https://docs.restate.dev/adminapi/get-deployment.md): Get deployment metadata
- [Get service](https://docs.restate.dev/adminapi/get-service.md): Get a registered service.
- [Get service handler](https://docs.restate.dev/adminapi/get-service-handler.md): Get the handler of a service
- [Get service OpenAPI](https://docs.restate.dev/adminapi/get-service-openapi.md): Get the service OpenAPI 3.1 contract.
- [Get subscription](https://docs.restate.dev/adminapi/get-subscription.md): Get subscription
- [Health check](https://docs.restate.dev/adminapi/health.md): Check REST API Health.
- [Health check](https://docs.restate.dev/adminapi/health.md): Check REST API Health.
- [invocation](https://docs.restate.dev/adminapi/invocation.md): invocation
- [Kill an invocation](https://docs.restate.dev/adminapi/kill-invocation.md): Kill the given invocation. This does not guarantee consistency for virtual object instance state, in-flight invocations to other services, etc.
- [List deployments](https://docs.restate.dev/adminapi/list-deployments.md): List all registered deployments.
- [List service handlers](https://docs.restate.dev/adminapi/list-service-handlers.md): List all the handlers of the given service.
- [List services](https://docs.restate.dev/adminapi/list-services.md): List all registered services.
- [List subscriptions](https://docs.restate.dev/adminapi/list-subscriptions.md): List all subscriptions.
- [Modify a service](https://docs.restate.dev/adminapi/modify-service.md): Modify a registered service.
- [Modify a service state](https://docs.restate.dev/adminapi/modify-service-state.md): Modify service state
- [OpenAPI specification](https://docs.restate.dev/adminapi/openapi-spec.md): OpenAPI specification
- [Purge an invocation](https://docs.restate.dev/adminapi/purge-invocation.md): Purge the given invocation. This cleanups all the state for the given invocation. This command applies only to completed invocations.
- [Purge an invocation journal](https://docs.restate.dev/adminapi/purge-journal.md): Purge the given invocation journal. This cleanups only the journal for the given invocation, retaining the metadata. This command applies only to completed invocations.
- [service](https://docs.restate.dev/adminapi/service.md): service
- [service_handler](https://docs.restate.dev/adminapi/service-handler.md): service_handler
- [subscription](https://docs.restate.dev/adminapi/subscription.md): subscription
- [Update deployment](https://docs.restate.dev/adminapi/update-deployment.md): Update deployment. Invokes the endpoint and replaces the existing deployment metadata with the discovered information. This is a dangerous operation that should be used only when there are failing invocations on the deployment that cannot be resolved any other way. Sense checks are applied to test that the new deployment is sufficiently similar to the old one.
- [Admin version information](https://docs.restate.dev/adminapi/version.md): Obtain admin version information.
- [Admin version information](https://docs.restate.dev/adminapi/version.md): Obtain admin version information.

## concepts

- [Durable Building Blocks](https://docs.restate.dev/concepts/durable_building_blocks.md)
- [Durable Execution](https://docs.restate.dev/concepts/durable_execution.md)
- [Invocations](https://docs.restate.dev/concepts/invocations.md)
- [Services](https://docs.restate.dev/concepts/services.md)

## deploy

- [Overview](https://docs.restate.dev/deploy/overview.md): Learn how to deploy Restate services.
- [Restate Cloud](https://docs.restate.dev/deploy/server/cloud.md): Learn how to use Restate Cloud.
- [Restate Cluster Deployment](https://docs.restate.dev/deploy/server/cluster.md): Learn how to deploy a distributed Restate cluster.
- [Deploying Restate Server on Kubernetes](https://docs.restate.dev/deploy/server/kubernetes.md): Learn how to run Restate applications on Kubernetes.
- [AWS EC2 with CDK](https://docs.restate.dev/deploy/server/self-hosted.md): Deploy Restate Server on EC2.
- [Deno Deploy](https://docs.restate.dev/deploy/services/faas/deno-deploy.md): TypeScript services on Deno Deploy.
- [AWS Lambda with CDK](https://docs.restate.dev/deploy/services/faas/lambda/cdk.md): Deploy services on AWS Lambda using CDK.
- [AWS Lambda + Java](https://docs.restate.dev/deploy/services/faas/lambda/lambda-java.md): Deploy Java services on AWS Lambda.
- [AWS Lambda + TypeScript](https://docs.restate.dev/deploy/services/faas/lambda/lambda-typescript.md): Deploy TypeScript services on AWS Lambda.
- [Cloudflare Workers](https://docs.restate.dev/deploy/services/faas/workers.md): TypeScript services on Cloudflare Workers.
- [Deploying Restate services](https://docs.restate.dev/deploy/services/kubernetes.md): Learn how to run Restate applications on Kubernetes.

## develop

<ExampleWidget itemsPerRow= boxStyling={"community-box"} features={[

- [Develop](https://docs.restate.dev/develop/.md): develop page
- [Awakeables](https://docs.restate.dev/develop/go/awakeables.md): Pause invocations until external completion.
- [Code generation](https://docs.restate.dev/develop/go/code-generation.md): Use proto for type-safe servers and clients.
- [Scheduling & Timers](https://docs.restate.dev/develop/go/durable-timers.md): Durable sleep tracked by Restate.
- [Error Handling](https://docs.restate.dev/develop/go/error-handling.md): Stop infinite retries with Terminal Errors.
- [Journaling Results](https://docs.restate.dev/develop/go/journaling-results.md): Persist results of operations.
- [Logging](https://docs.restate.dev/develop/go/logging.md): Configure the log level of your services.
- [Overview](https://docs.restate.dev/develop/go/overview.md): Services, Virtual Objects, and Workflows.
- [Service Communication](https://docs.restate.dev/develop/go/service-communication.md): Call other services from your handler.
- [Serving](https://docs.restate.dev/develop/go/serving.md): Create an endpoint to serve your services.
- [State](https://docs.restate.dev/develop/go/state.md): Keep K/V state in Restate.
- [Workflows](https://docs.restate.dev/develop/go/workflows.md): Workflows and what you can do with them.
- [Awakeables](https://docs.restate.dev/develop/java/awakeables.md): Pause invocations until external completion.
- [Clients](https://docs.restate.dev/develop/java/clients.md): Invoke services from non-Restate services.
- [Scheduling & Timers](https://docs.restate.dev/develop/java/durable-timers.md): Durable sleep tracked by Restate.
- [Error Handling](https://docs.restate.dev/develop/java/error-handling.md): Stop infinite retries with Terminal Exceptions.
- [Journaling Results](https://docs.restate.dev/develop/java/journaling-results.md): Persist results of operations.
- [Logging](https://docs.restate.dev/develop/java/logging.md): Configure the log level of your services.
- [Overview](https://docs.restate.dev/develop/java/overview.md): Services, Virtual Objects, and Workflows.
- [Serialization](https://docs.restate.dev/develop/java/serialization.md): Customize serialization for SDK actions.
- [Service Communication](https://docs.restate.dev/develop/java/service-communication.md): Call other services from your handler.
- [Serving](https://docs.restate.dev/develop/java/serving.md): Create an endpoint to serve your services.
- [State](https://docs.restate.dev/develop/java/state.md): Keep K/V state in Restate.
- [Testing](https://docs.restate.dev/develop/java/testing.md): Test your handler logic.
- [Workflows](https://docs.restate.dev/develop/java/workflows.md): Workflows and what you can do with them.
- [Installation](https://docs.restate.dev/develop/local_dev.md): Learn how to set up your local dev environment
- [Awakeables](https://docs.restate.dev/develop/python/awakeables.md): Pause invocations until external completion.
- [Scheduling & Timers](https://docs.restate.dev/develop/python/durable-timers.md): Durable sleep tracked by Restate.
- [Error Handling](https://docs.restate.dev/develop/python/error-handling.md): Stop infinite retries with Terminal Errors.
- [Journaling Results](https://docs.restate.dev/develop/python/journaling-results.md): Persist results of operations.
- [Overview](https://docs.restate.dev/develop/python/overview.md): Services, Virtual Objects, and Workflows.
- [Serialization](https://docs.restate.dev/develop/python/serialization.md): Customize serialization for SDK actions.
- [Service Communication](https://docs.restate.dev/develop/python/service-communication.md): Call other services from your handler.
- [Serving](https://docs.restate.dev/develop/python/serving.md): Create an endpoint to serve your services.
- [State](https://docs.restate.dev/develop/python/state.md): Keep K/V state in Restate.
- [Workflows](https://docs.restate.dev/develop/python/workflows.md): Workflows and what you can do with them.
- [Awakeables](https://docs.restate.dev/develop/ts/awakeables.md): Pause invocations until external completion.
- [Clients](https://docs.restate.dev/develop/ts/clients.md): Invoke services from non-Restate services.
- [Scheduling & Timers](https://docs.restate.dev/develop/ts/durable-timers.md): Durable sleep tracked by Restate.
- [Error Handling](https://docs.restate.dev/develop/ts/error-handling.md): Stop infinite retries with Terminal Errors.
- [Journaling Results](https://docs.restate.dev/develop/ts/journaling-results.md): Persist results of operations.
- [Logging](https://docs.restate.dev/develop/ts/logging.md): Configure the log level of your services.
- [Overview](https://docs.restate.dev/develop/ts/overview.md): Services, Virtual Objects, and Workflows.
- [Serialization](https://docs.restate.dev/develop/ts/serialization.md): Customize serialization for SDK actions.
- [Service Communication](https://docs.restate.dev/develop/ts/service-communication.md): Call other services from your handler.
- [Serving](https://docs.restate.dev/develop/ts/serving.md): Create an endpoint to serve your services.
- [State](https://docs.restate.dev/develop/ts/state.md): Keep K/V state in Restate.
- [Testing](https://docs.restate.dev/develop/ts/testing.md): Test your handler logic.
- [Workflows](https://docs.restate.dev/develop/ts/workflows.md): Workflows and what you can do with them.

## get_started

- [Quickstart](https://docs.restate.dev/get_started/quickstart.md)
- [Tour of Restate](https://docs.restate.dev/get_started/tour.md)

## guides

Guides

- [Guides](https://docs.restate.dev/guides.md): guides page
- [Deploying a distributed Restate cluster using Docker](https://docs.restate.dev/guides/cluster.md): Learn how to deploy a Restate cluster using Docker.
- [Cron Jobs](https://docs.restate.dev/guides/cron.md): Schedule tasks periodically with Restate.
- [Databases and Restate](https://docs.restate.dev/guides/databases.md): Learn when and how to use databases in combination with Restate.
- [Durable webhooks](https://docs.restate.dev/guides/durable-webhooks.md): Point webhook callbacks to a Restate handler for durable event processing.
- [Error Handling](https://docs.restate.dev/guides/error-handling.md): Learn how to handle transient and terminal errors in your applications.
- [Restate + Kafka: Quickstart](https://docs.restate.dev/guides/kafka-quickstart.md): Learn how to connect your Restate service to a Kafka topic.
- [Deploying Restate TypeScript services on AWS Lambda](https://docs.restate.dev/guides/lambda-ts.md): Learn how to run Restate TypeScript services on AWS Lambda.
- [Migrating a single-node to a multi-node deployment](https://docs.restate.dev/guides/local-to-replicated.md): Learn how to migrate from a single node to a multi-node cluster using the replicated loglet and replicated metadata server.
- [Parallelizing work](https://docs.restate.dev/guides/parallelizing-work.md): Execute a list of tasks in parallel and then gather their result.
- [Sagas](https://docs.restate.dev/guides/sagas.md): Implementing undo operations in case of failures, to keep your system consistent

## invoke

- [Clients](https://docs.restate.dev/invoke/clients.md): Use the clients to invoke handlers programmatically.
- [HTTP](https://docs.restate.dev/invoke/http.md): Invoke handlers over HTTP.
- [Kafka](https://docs.restate.dev/invoke/kafka.md): Invoke handlers via Kafka events.

## operate

Tooling

- [Operate](https://docs.restate.dev/operate/.md): operate page
- [Operating Clusters](https://docs.restate.dev/operate/clusters.md): Resolving common problems with Restate deployments
- [Restate CLI Configuration](https://docs.restate.dev/operate/configuration/cli.md): Restate CLI configuration options.
- [Restate Server Configuration](https://docs.restate.dev/operate/configuration/server.md): Restate Server configuration options.
- [Restate Service Configuration](https://docs.restate.dev/operate/configuration/services.md): Restate services configuration options.
- [Data Backups](https://docs.restate.dev/operate/data-backup.md): Backing up and restoring the Restate data store on single nodes
- [Introspection](https://docs.restate.dev/operate/introspection.md): Learn how to inspect/troubleshoot stuck or failing invocations.
- [Managing Invocations](https://docs.restate.dev/operate/invocation.md): Explore the different ways to invoke Restate services.
- [Logging](https://docs.restate.dev/operate/monitoring/logging.md): Configure logging for Restate Server.
- [Metrics](https://docs.restate.dev/operate/monitoring/metrics.md): Scrape Restate Server Prometheus metrics.
- [Tracing](https://docs.restate.dev/operate/monitoring/tracing.md): Export OTEL traces of your invocations.
- [Registration](https://docs.restate.dev/operate/registration.md): Find out how to register new deployments with Restate.
- [Security](https://docs.restate.dev/operate/security.md): Restrict access to Restate services
- [Snapshots](https://docs.restate.dev/operate/snapshots.md): Backing up and restoring the Restate data store on single nodes
- [Upgrading](https://docs.restate.dev/operate/upgrading.md): Restate installation software version upgrades, compatibility policy, rollback strategy
- [Versioning](https://docs.restate.dev/operate/versioning.md): All you need to know on upgrading deployments.

## references

- [Restate Architecture](https://docs.restate.dev/references/architecture.md): Restate architecture and distributed deployment concepts
- [Error codes](https://docs.restate.dev/references/errors.md): This page contains the list of error codes emitted by Restate components.
- [Restate Server Configuration Reference](https://docs.restate.dev/references/server_config.md): Specification of the API to administer services.
- [SQL Introspection API](https://docs.restate.dev/references/sql-introspection.md): API reference for inspecting the invocation status and service state.

## use-cases

- [Async tasks](https://docs.restate.dev/use-cases/async-tasks.md): Schedule async tasks and let Restate manage their execution.
- [Event Processing](https://docs.restate.dev/use-cases/event-processing.md): Write event processing apps with Restate
- [Microservice Orchestration](https://docs.restate.dev/use-cases/microservice-orchestration.md): Write resilient microservices with Restate
- [Workflows-as-code](https://docs.restate.dev/use-cases/workflows.md): Write workflows-as-code with Restate