Restate Ingress API

The Restate Ingress API is the HTTP data-plane for invoking services, virtual objects, and workflows running on Restate Server, exposed by default on port 8080. Requests follow the path conventions /{ServiceName}/{handler}, /{VirtualObject}/{key}/{handler}, and /{Workflow}/{workflowId}/run, with JSON bodies. Append /send for fire-and-forget invocations that return an invocation ID, pass a ?delay= parameter for delayed/scheduled invocations, and use the Idempotency-Key header for at-most-once semantics (responses are cached for 24 hours). The Ingress also brokers Kafka-event-driven handler invocations and exposes per-service OpenAPI documents at :9070/services/{ServiceName}/openapi.

Restate Ingress API is one of 3 APIs that Restate publishes on the APIs.io network.

Tagged areas include Data Plane, HTTP, Idempotency, Ingress, and Invocation. The published artifact set on APIs.io includes API documentation and a GitHub repository.

API entry from apis.yml

apis.yml Raw ↑
aid: restate-dev:ingress-api
name: Restate Ingress API
description: The Restate Ingress API is the HTTP data-plane for invoking services, virtual objects, and
  workflows running on Restate Server, exposed by default on port 8080. Requests follow the path conventions
  /{ServiceName}/{handler}, /{VirtualObject}/{key}/{handler}, and /{Workflow}/{workflowId}/run, with JSON
  bodies. Append /send for fire-and-forget invocations that return an invocation ID, pass a ?delay= parameter
  for delayed/scheduled invocations, and use the Idempotency-Key header for at-most-once semantics (responses
  are cached for 24 hours). The Ingress also brokers Kafka-event-driven handler invocations and exposes
  per-service OpenAPI documents at :9070/services/{ServiceName}/openapi.
humanURL: https://docs.restate.dev/invoke/http
tags:
- Data Plane
- HTTP
- Idempotency
- Ingress
- Invocation
- Virtual Objects
- Workflows
properties:
- type: Documentation
  url: https://docs.restate.dev/invoke/http
- type: GitHubRepository
  url: https://github.com/restatedev/restate