Get deployment

Returns detailed information about a registered deployment, including deployment metadata and the services it exposes.

GET /deployments/{deployment}

Get deployment

cURL

curl --request GET \
  --url https://api.example.com/deployments/{deployment}

import requests

url = "https://api.example.com/deployments/{deployment}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/deployments/{deployment}', 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/{deployment}",
  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/deployments/{deployment}"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/deployments/{deployment}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/deployments/{deployment}")

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

200

{
  "created_at": "<string>",
  "http_version": "<string>",
  "id": "<string>",
  "max_protocol_version": 123,
  "min_protocol_version": 123,
  "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>"
          }
        }
      ],
      "name": "<string>",
      "revision": 1,
      "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>"
      },
      "workflow_completion_retention": "<string>"
    }
  ],
  "uri": "<string>",
  "additional_headers": {},
  "auth": {
    "GoogleIdToken": {
      "audience": "<string>",
      "impersonate_service_account": "<string>"
    }
  },
  "info": [
    {
      "message": "<string>",
      "code": "<string>"
    }
  ],
  "metadata": {},
  "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>"
}

Path Parameters

deployment · string · required

Deployment identifier

Response

200

application/json

Deployment details including services and configuration

HttpDetailedDeploymentResponse

LambdaDetailedDeploymentResponse

Detailed information about Restate deployments

created_at · string · required

http_version · string · required

HTTP Version

HTTP Version used to invoke this service deployment.

id · string · required

Deployment ID

max_protocol_version · integer<int32> · required

Maximum Service Protocol version

During registration, the SDKs declare a range from minimum (included) to maximum (included) Service Protocol supported version.

min_protocol_version · integer<int32> · required

Minimum Service Protocol version

During registration, the SDKs declare a range from minimum (included) to maximum (included) Service Protocol supported version.

protocol_type · enum<string> · required

Protocol Type

Protocol type used to invoke this service deployment.

Available options: RequestResponse, BidiStream

services · object[] · required

Services

List of services exposed by this deployment.

Show child attributes

uri · string<uri> · required

Deployment URI

URI used to invoke this service deployment.

additional_headers · object

Additional headers

Additional headers used to invoke this service deployment.

Show child attributes

auth · null | object

Authentication

Per-deployment authentication, if configured.

Show child attributes

info · object[]

Info

List of configuration/deprecation information related to this deployment.

Show child attributes

metadata · object

Metadata

Deployment metadata.

Show child attributes

sdk_version · string | null

SDK version

SDK library and version declared during registration.