Register deployment
curl --request POST \
--url https://api.example.com/deployments \
--header 'Content-Type: application/json' \
--data '
{
"uri": "<string>",
"additional_headers": {},
"auth": {
"GoogleIdToken": {
"allow_insecure_transport": true,
"audience": "<string>",
"impersonate_service_account": "<string>",
"workload_identity_provider": "<string>"
}
},
"breaking": true,
"dry_run": true,
"force": true,
"metadata": {},
"use_http_11": true
}
'import requests
url = "https://api.example.com/deployments"
payload = {
"uri": "<string>",
"additional_headers": {},
"auth": { "GoogleIdToken": {
"allow_insecure_transport": True,
"audience": "<string>",
"impersonate_service_account": "<string>",
"workload_identity_provider": "<string>"
} },
"breaking": True,
"dry_run": True,
"force": True,
"metadata": {},
"use_http_11": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
uri: '<string>',
additional_headers: {},
auth: {
GoogleIdToken: {
allow_insecure_transport: true,
audience: '<string>',
impersonate_service_account: '<string>',
workload_identity_provider: '<string>'
}
},
breaking: true,
dry_run: true,
force: true,
metadata: {},
use_http_11: true
})
};
fetch('https://api.example.com/deployments', 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/deployments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'uri' => '<string>',
'additional_headers' => [
],
'auth' => [
'GoogleIdToken' => [
'allow_insecure_transport' => true,
'audience' => '<string>',
'impersonate_service_account' => '<string>',
'workload_identity_provider' => '<string>'
]
],
'breaking' => true,
'dry_run' => true,
'force' => true,
'metadata' => [
],
'use_http_11' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/deployments"
payload := strings.NewReader("{\n \"uri\": \"<string>\",\n \"additional_headers\": {},\n \"auth\": {\n \"GoogleIdToken\": {\n \"allow_insecure_transport\": true,\n \"audience\": \"<string>\",\n \"impersonate_service_account\": \"<string>\",\n \"workload_identity_provider\": \"<string>\"\n }\n },\n \"breaking\": true,\n \"dry_run\": true,\n \"force\": true,\n \"metadata\": {},\n \"use_http_11\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/deployments")
.header("Content-Type", "application/json")
.body("{\n \"uri\": \"<string>\",\n \"additional_headers\": {},\n \"auth\": {\n \"GoogleIdToken\": {\n \"allow_insecure_transport\": true,\n \"audience\": \"<string>\",\n \"impersonate_service_account\": \"<string>\",\n \"workload_identity_provider\": \"<string>\"\n }\n },\n \"breaking\": true,\n \"dry_run\": true,\n \"force\": true,\n \"metadata\": {},\n \"use_http_11\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"uri\": \"<string>\",\n \"additional_headers\": {},\n \"auth\": {\n \"GoogleIdToken\": {\n \"allow_insecure_transport\": true,\n \"audience\": \"<string>\",\n \"impersonate_service_account\": \"<string>\",\n \"workload_identity_provider\": \"<string>\"\n }\n },\n \"breaking\": true,\n \"dry_run\": true,\n \"force\": true,\n \"metadata\": {},\n \"use_http_11\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"services": [
{
"deployment_id": "<string>",
"handlers": [
{
"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"
}
],
"name": "<string>",
"revision": 1,
"ty": "Service",
"abort_timeout": "<string>",
"documentation": "<string>",
"enable_lazy_state": true,
"idempotency_retention": "<string>",
"inactivity_timeout": "<string>",
"info": [
{
"message": "<string>",
"code": "<string>"
}
],
"journal_retention": "<string>",
"metadata": {},
"public": true,
"retry_policy": {
"exponentiation_factor": 123,
"initial_interval": "<string>",
"max_attempts": 2,
"max_interval": "<string>",
"on_max_attempts": "Pause"
},
"state_preload_policy": "All",
"workflow_completion_retention": "<string>"
}
],
"info": [
{
"message": "<string>",
"code": "<string>"
}
],
"max_protocol_version": 123,
"min_protocol_version": 123,
"sdk_version": "<string>"
}{
"id": "<string>",
"services": [
{
"deployment_id": "<string>",
"handlers": [
{
"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"
}
],
"name": "<string>",
"revision": 1,
"ty": "Service",
"abort_timeout": "<string>",
"documentation": "<string>",
"enable_lazy_state": true,
"idempotency_retention": "<string>",
"inactivity_timeout": "<string>",
"info": [
{
"message": "<string>",
"code": "<string>"
}
],
"journal_retention": "<string>",
"metadata": {},
"public": true,
"retry_policy": {
"exponentiation_factor": 123,
"initial_interval": "<string>",
"max_attempts": 2,
"max_interval": "<string>",
"on_max_attempts": "Pause"
},
"state_preload_policy": "All",
"workflow_completion_retention": "<string>"
}
],
"info": [
{
"message": "<string>",
"code": "<string>"
}
],
"max_protocol_version": 123,
"min_protocol_version": 123,
"sdk_version": "<string>"
}{
"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>"
}deployment
Register deployment
Registers a new deployment (HTTP or Lambda). Restate will invoke the endpoint to discover available services and handlers, and make them available for invocation. For more information, see the deployment documentation.
POST
/
deployments
Register deployment
curl --request POST \
--url https://api.example.com/deployments \
--header 'Content-Type: application/json' \
--data '
{
"uri": "<string>",
"additional_headers": {},
"auth": {
"GoogleIdToken": {
"allow_insecure_transport": true,
"audience": "<string>",
"impersonate_service_account": "<string>",
"workload_identity_provider": "<string>"
}
},
"breaking": true,
"dry_run": true,
"force": true,
"metadata": {},
"use_http_11": true
}
'import requests
url = "https://api.example.com/deployments"
payload = {
"uri": "<string>",
"additional_headers": {},
"auth": { "GoogleIdToken": {
"allow_insecure_transport": True,
"audience": "<string>",
"impersonate_service_account": "<string>",
"workload_identity_provider": "<string>"
} },
"breaking": True,
"dry_run": True,
"force": True,
"metadata": {},
"use_http_11": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
uri: '<string>',
additional_headers: {},
auth: {
GoogleIdToken: {
allow_insecure_transport: true,
audience: '<string>',
impersonate_service_account: '<string>',
workload_identity_provider: '<string>'
}
},
breaking: true,
dry_run: true,
force: true,
metadata: {},
use_http_11: true
})
};
fetch('https://api.example.com/deployments', 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/deployments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'uri' => '<string>',
'additional_headers' => [
],
'auth' => [
'GoogleIdToken' => [
'allow_insecure_transport' => true,
'audience' => '<string>',
'impersonate_service_account' => '<string>',
'workload_identity_provider' => '<string>'
]
],
'breaking' => true,
'dry_run' => true,
'force' => true,
'metadata' => [
],
'use_http_11' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/deployments"
payload := strings.NewReader("{\n \"uri\": \"<string>\",\n \"additional_headers\": {},\n \"auth\": {\n \"GoogleIdToken\": {\n \"allow_insecure_transport\": true,\n \"audience\": \"<string>\",\n \"impersonate_service_account\": \"<string>\",\n \"workload_identity_provider\": \"<string>\"\n }\n },\n \"breaking\": true,\n \"dry_run\": true,\n \"force\": true,\n \"metadata\": {},\n \"use_http_11\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/deployments")
.header("Content-Type", "application/json")
.body("{\n \"uri\": \"<string>\",\n \"additional_headers\": {},\n \"auth\": {\n \"GoogleIdToken\": {\n \"allow_insecure_transport\": true,\n \"audience\": \"<string>\",\n \"impersonate_service_account\": \"<string>\",\n \"workload_identity_provider\": \"<string>\"\n }\n },\n \"breaking\": true,\n \"dry_run\": true,\n \"force\": true,\n \"metadata\": {},\n \"use_http_11\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"uri\": \"<string>\",\n \"additional_headers\": {},\n \"auth\": {\n \"GoogleIdToken\": {\n \"allow_insecure_transport\": true,\n \"audience\": \"<string>\",\n \"impersonate_service_account\": \"<string>\",\n \"workload_identity_provider\": \"<string>\"\n }\n },\n \"breaking\": true,\n \"dry_run\": true,\n \"force\": true,\n \"metadata\": {},\n \"use_http_11\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"services": [
{
"deployment_id": "<string>",
"handlers": [
{
"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"
}
],
"name": "<string>",
"revision": 1,
"ty": "Service",
"abort_timeout": "<string>",
"documentation": "<string>",
"enable_lazy_state": true,
"idempotency_retention": "<string>",
"inactivity_timeout": "<string>",
"info": [
{
"message": "<string>",
"code": "<string>"
}
],
"journal_retention": "<string>",
"metadata": {},
"public": true,
"retry_policy": {
"exponentiation_factor": 123,
"initial_interval": "<string>",
"max_attempts": 2,
"max_interval": "<string>",
"on_max_attempts": "Pause"
},
"state_preload_policy": "All",
"workflow_completion_retention": "<string>"
}
],
"info": [
{
"message": "<string>",
"code": "<string>"
}
],
"max_protocol_version": 123,
"min_protocol_version": 123,
"sdk_version": "<string>"
}{
"id": "<string>",
"services": [
{
"deployment_id": "<string>",
"handlers": [
{
"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"
}
],
"name": "<string>",
"revision": 1,
"ty": "Service",
"abort_timeout": "<string>",
"documentation": "<string>",
"enable_lazy_state": true,
"idempotency_retention": "<string>",
"inactivity_timeout": "<string>",
"info": [
{
"message": "<string>",
"code": "<string>"
}
],
"journal_retention": "<string>",
"metadata": {},
"public": true,
"retry_policy": {
"exponentiation_factor": 123,
"initial_interval": "<string>",
"max_attempts": 2,
"max_interval": "<string>",
"on_max_attempts": "Pause"
},
"state_preload_policy": "All",
"workflow_completion_retention": "<string>"
}
],
"info": [
{
"message": "<string>",
"code": "<string>"
}
],
"max_protocol_version": 123,
"min_protocol_version": 123,
"sdk_version": "<string>"
}{
"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>"
}Body
application/json
- RegisterHttpDeploymentRequest
- RegisterLambdaDeploymentRequest
Register HTTP deployment request
Uri
Uri to use to discover/invoke the http deployment.
Additional headers
Additional headers added to every discover/invoke request to the deployment.
You typically want to include here API keys and other tokens required to send requests to deployments.
Show child attributes
Show child attributes
Authentication
Optional per-deployment authentication configuration. When set to GoogleIdToken,
Restate mints a Google-signed OIDC ID token for each request and attaches it as
X-Serverless-Authorization: Bearer <token>. Cloud Run validates this header in
precedence over Authorization and strips it before forwarding to the container, so any
Authorization placed in additional_headers passes through to the workload unchanged.
Show child attributes
Show child attributes
Breaking
If true, it allows registering new service revisions with
schemas incompatible with previous service revisions, such as changing the service type.
See the versioning documentation for more information.
Dry-run mode
If true, discovery will run but the deployment will not be registered.
This is useful to see the impact of a new deployment before registering it.
force and breaking will be respected.
Force
If true, it overrides, if existing, any deployment using the same uri.
Beware that this can lead inflight invocations to an unrecoverable error state.
When set to true, it implies breaking = true.
See the versioning documentation for more information.
Metadata
Deployment metadata.
Show child attributes
Show child attributes
Use http1.1
If true, discovery will be attempted using a client that defaults to HTTP1.1
instead of a prior-knowledge HTTP2 client. HTTP2 may still be used for TLS servers
that advertise HTTP2 support via ALPN. HTTP1.1 deployments will only work in
request-response mode.
Response
Deployment already exists. No change if force = false, services overwritten if force = true
Show child attributes
Show child attributes
Info
List of configuration/deprecation information related to this deployment.
Show child attributes
Show child attributes
Maximum Service Protocol version
During registration, the SDKs declare a range from minimum (included) to maximum (included) Service Protocol supported version.
Minimum Service Protocol version
During registration, the SDKs declare a range from minimum (included) to maximum (included) Service Protocol supported version.
SDK version
SDK library and version declared during registration.