Modify service configuration
Updates the configuration of a registered service, such as public visibility, retention policies, and timeout settings. Note: Service re-discovery will update these settings based on the service endpoint configuration.
Path parameters
Fully qualified service name.
Request body
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.
This overrides the default abort timeout set in invoker options.
Idempotency retention
Modify the retention of idempotent requests for this service.
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
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.
This overrides the default inactivity timeout set in invoker options.
Journal retention
Modify the journal retention for this service. 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.
Public
If true, the service can be invoked through the ingress. If false, the service can be invoked only from another Restate service.
Workflow completion retention
Modify the retention of the workflow completion. This can be modified only for workflow services!
Can be configured using the jiff::fmt::friendly format or ISO8601, for example 5 hours.
Response
Service configuration updated successfully
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.
Documentation
Documentation of the service, as propagated by the SDKs.
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 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 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 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.
Metadata
Additional service metadata, as propagated by the SDKs.
Name
Fully qualified name of the service
Public
If true, the service can be invoked through the ingress. If false, the service can be invoked only from another Restate service.
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.