Get service handler

curl --request GET \
  --url https://api.example.com/services/{service}/handlers/{handler}

const options = {method: 'GET'};

fetch('https://api.example.com/services/{service}/handlers/{handler}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/services/{service}/handlers/{handler}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/services/{service}/handlers/{handler}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/services/{service}/handlers/{handler}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "input_description": "<string>",
  "name": "<string>",
  "output_description": "<string>",
  "abort_timeout": "<string>",
  "documentation": "<string>",
  "enable_lazy_state": true,
  "idempotency_retention": "<string>",
  "inactivity_timeout": "<string>",
  "info": [
    {
      "message": "<string>",
      "code": "<string>"
    }
  ],
  "input_json_schema": "<unknown>",
  "journal_retention": "<string>",
  "metadata": {},
  "output_json_schema": "<unknown>",
  "public": true,
  "retry_policy": {
    "exponentiation_factor": 123,
    "initial_interval": "<string>",
    "max_attempts": 2,
    "max_interval": "<string>",
    "on_max_attempts": "Pause"
  },
  "state_preload_policy": "All",
  "ty": "Exclusive"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

GET

services

{service}

handlers

{handler}

Get service handler

curl --request GET \
  --url https://api.example.com/services/{service}/handlers/{handler}

const options = {method: 'GET'};

fetch('https://api.example.com/services/{service}/handlers/{handler}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/services/{service}/handlers/{handler}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/services/{service}/handlers/{handler}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/services/{service}/handlers/{handler}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "input_description": "<string>",
  "name": "<string>",
  "output_description": "<string>",
  "abort_timeout": "<string>",
  "documentation": "<string>",
  "enable_lazy_state": true,
  "idempotency_retention": "<string>",
  "inactivity_timeout": "<string>",
  "info": [
    {
      "message": "<string>",
      "code": "<string>"
    }
  ],
  "input_json_schema": "<unknown>",
  "journal_retention": "<string>",
  "metadata": {},
  "output_json_schema": "<unknown>",
  "public": true,
  "retry_policy": {
    "exponentiation_factor": 123,
    "initial_interval": "<string>",
    "max_attempts": 2,
    "max_interval": "<string>",
    "on_max_attempts": "Pause"
  },
  "state_preload_policy": "All",
  "ty": "Exclusive"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

Path Parameters

service

string

required

Fully qualified service name.

handler

string

required

Handler name.

Response

Handler metadata including input/output types and configuration

Handler metadata

input_description

string

required

Human readable input description

If empty, no schema was provided by the user at discovery time.

name

string

required

Name

The handler name.

output_description

string

required

Human readable output description

If empty, no schema was provided by the user at discovery time.

abort_timeout

string | null

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 set, it overrides the value set in the service.

documentation

string | null

Documentation

Documentation of the handler, as propagated by the SDKs.

enable_lazy_state

boolean | null

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.

If set, it overrides the value set in the service.

idempotency_retention

string | null

Idempotency retention

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.

inactivity_timeout

string | null

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 set, it overrides the value set in the service.

info

object[]

Info

List of configuration/deprecation information related to this handler.

Show child attributes

input_json_schema

any

Input JSON Schema

JSON Schema of the handler input

journal_retention

string | null

Journal retention

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.

metadata

object

Metadata

Additional handler metadata, as propagated by the SDKs.

Show child attributes

output_json_schema

any

Output JSON Schema

JSON Schema of the handler output

public

boolean

Public

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

retry_policy

object

Retry policy

Retry policy overrides applied for this handler.

Show child attributes

state_preload_policy

State preload policy

Which state is preloaded (sent eagerly) at the start of an invocation to this handler. This is relevant only for Workflows and Virtual Objects.

If set, it overrides the service-level policy.

"All" preloads all state eagerly; {"Partial": ["key", ...]} preloads only the listed keys eagerly (an empty list means fully lazy state).

Available options:

All

enum<string> | null

Type

The handler type.

Available options:

Exclusive,

Shared,

Workflow

SDKs

Services

Restate Cloud / BYOC / OSS

References

Get service handler

Path Parameters

Response

Human readable input description

Name

Human readable output description

Abort timeout

Documentation

Enable lazy state

Idempotency retention

Inactivity timeout

Info

Input JSON Schema

Journal retention

Metadata

Output JSON Schema

Public

Retry policy

State preload policy

Type