Sign in

v7

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-07-07355390.1 KB
service

Get service

Returns detailed metadata about a specific service, including its type, handlers, and configuration settings.

get/services/{service}

Path parameters

servicestring required

Fully qualified service name.

Response

Service metadata including type, revision, handlers, and configuration

abort_timeoutstring

Abort timeout

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.

deployment_idstring required
documentationstring nullable

Documentation

Documentation of the service, as propagated by the SDKs.

enable_lazy_stateboolean

Enable lazy state

If true, lazy state will be enabled for all invocations to this service. This is relevant only for Workflows and Virtual Objects.

idempotency_retentionstring

Idempotency retention

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.

inactivity_timeoutstring

Inactivity timeout

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.

journal_retentionstring nullable

Journal retention

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.

metadataobject

Metadata

Additional service metadata, as propagated by the SDKs.

namestring required

Name

Fully qualified name of the service

publicboolean

Public

If true, the service can be invoked through the ingress. If false, the service can be invoked only from another Restate service.

revisioninteger required
ty'Service' | 'VirtualObject' | 'Workflow' required
workflow_completion_retentionstring nullable

Workflow completion retention

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.