Restate Cloud
Self-hosted Restate
{
"services": [
{
"name": "<string>",
"ty": "Service",
"handlers": [
{
"name": "<string>",
"input_description": "<string>",
"output_description": "<string>",
"ty": "Exclusive",
"documentation": "<string>",
"metadata": {},
"idempotency_retention": "<string>",
"journal_retention": "<string>",
"inactivity_timeout": "<string>",
"abort_timeout": "<string>",
"enable_lazy_state": true,
"public": true,
"input_json_schema": "<unknown>",
"output_json_schema": "<unknown>",
"retry_policy": {}
}
],
"deployment_id": "<string>",
"revision": 1,
"documentation": "<string>",
"metadata": {},
"public": true,
"idempotency_retention": "1d",
"workflow_completion_retention": "<string>",
"journal_retention": "<string>",
"inactivity_timeout": "1m",
"abort_timeout": "1m",
"enable_lazy_state": false,
"retry_policy": {
"exponentiation_factor": 2,
"initial_interval": "100ms",
"max_attempts": null,
"max_interval": null,
"on_max_attempts": "Pause"
}
}
]
}List services
List all registered services.
{
"services": [
{
"name": "<string>",
"ty": "Service",
"handlers": [
{
"name": "<string>",
"input_description": "<string>",
"output_description": "<string>",
"ty": "Exclusive",
"documentation": "<string>",
"metadata": {},
"idempotency_retention": "<string>",
"journal_retention": "<string>",
"inactivity_timeout": "<string>",
"abort_timeout": "<string>",
"enable_lazy_state": true,
"public": true,
"input_json_schema": "<unknown>",
"output_json_schema": "<unknown>",
"retry_policy": {}
}
],
"deployment_id": "<string>",
"revision": 1,
"documentation": "<string>",
"metadata": {},
"public": true,
"idempotency_retention": "1d",
"workflow_completion_retention": "<string>",
"journal_retention": "<string>",
"inactivity_timeout": "1m",
"abort_timeout": "1m",
"enable_lazy_state": false,
"retry_policy": {
"exponentiation_factor": 2,
"initial_interval": "100ms",
"max_attempts": null,
"max_interval": null,
"on_max_attempts": "Pause"
}
}
]
}Response
Show child attributes
Show child attributes
Fully qualified name of the service
Service type
Service, VirtualObject, Workflow Handlers for this service.
Show child attributes
Show child attributes
The handler name.
If empty, no schema was provided by the user at discovery time.
If empty, no schema was provided by the user at discovery time.
The handler type.
Exclusive, Shared, Workflow Documentation of the handler, as propagated by the SDKs.
The retention duration of idempotent requests for this handler. If set, it overrides the value set in the service.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
The journal retention. When set, this applies to all requests to this handler.
In case the invocation has an idempotency key, the idempotency_retention caps the maximum journal_retention time. In case this handler is a workflow handler, the workflow_completion_retention caps the maximum journal_retention time.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
If set, it overrides the value set in the service.
This timer guards against stalled service/handler invocations. Once it expires, Restate triggers a graceful termination by asking the service invocation to suspend (which preserves intermediate progress).
The 'abort timeout' is used to abort the invocation, in case it doesn't react to the request to suspend.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
If set, it overrides the value set in the service.
This timer guards against stalled service/handler invocations that are supposed to terminate. The abort timeout is started after the 'inactivity timeout' has expired and the service/handler invocation has been asked to gracefully terminate. Once the timer expires, it will abort the service/handler invocation.
This timer potentially interrupts user code. If the user code needs longer to gracefully terminate, then this value needs to be set accordingly.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
If set, it overrides the value set in the service.
If true, lazy state will be enabled for all invocations to this service. This is relevant only for Workflows and Virtual Objects.
If set, it overrides the value set in the service.
If true, this handler can be invoked through the ingress. If false, this handler can be invoked only from another Restate service.
JSON Schema of the handler input
JSON Schema of the handler output
Retry policy overrides applied for this handler.
Show child attributes
Show child attributes
Initial interval for the first retry attempt.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
The factor to use to compute the next retry attempt.
Number of maximum attempts (including the initial) before giving up. Infinite retries if unset. No retries if set to 1.
x >= 1Maximum interval between retries.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
Behavior when max attempts are reached.
Pause Deployment exposing the latest revision of the service.
Latest revision of the service.
x >= 0Documentation of the service, as propagated by the SDKs.
If true, the service can be invoked through the ingress. If false, the service can be invoked only from another Restate service.
The retention duration of idempotent requests for this service.
If not configured, this returns the default idempotency retention.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
The retention duration of workflows. Only available on workflow services.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
The journal retention. When set, this applies to all requests to all handlers of this service.
In case the invocation has an idempotency key, the idempotency_retention caps the maximum journal_retention time. In case the invocation targets a workflow handler, the workflow_completion_retention caps the maximum journal_retention time.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
This timer guards against stalled service/handler invocations. Once it expires, Restate triggers a graceful termination by asking the service invocation to suspend (which preserves intermediate progress).
The 'abort timeout' is used to abort the invocation, in case it doesn't react to the request to suspend.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
If unset, this returns the default inactivity timeout configured in invoker options.
This timer guards against stalled service/handler invocations that are supposed to terminate. The abort timeout is started after the 'inactivity timeout' has expired and the service/handler invocation has been asked to gracefully terminate. Once the timer expires, it will abort the service/handler invocation.
This timer potentially interrupts user code. If the user code needs longer to gracefully terminate, then this value needs to be set accordingly.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
If unset, this returns the default abort timeout configured in invoker options.
If true, lazy state will be enabled for all invocations to this service. This is relevant only for Workflows and Virtual Objects.
Retry policy applied to invocations of this service.
If unset, it returns the default values configured in the Restate configuration.
Show child attributes
Show child attributes
Initial interval for the first retry attempt.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
The factor to use to compute the next retry attempt. Default: 2.0.
Number of maximum attempts (including the initial) before giving up. Infinite retries if unset. No retries if set to 1.
x >= 1Maximum interval between retries.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
Behavior when max attempts are reached.
Pause Was this page helpful?