Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Restate deployment API

Service Deployment management

Restate deployment API is one of 9 APIs that Restate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and 2 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 1.4.0.

Requests are made against the base URL http://localhost:9070.

5 operations 2 paths 15 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.4.0
Base URL
http://localhost:9070
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

deployment 5

Service Deployment management

GET
/deployments
List Deployments
list_deployments → 200
POST
/deployments
Create Deployment
create_deployment body → 201400403404409500503
GET
/deployments/{deployment}
Get Deployment
get_deployment 1 param → 200400403404409500503
PUT
/deployments/{deployment}
Update Deployment
update_deployment 1 param body → 200400403404409500503
DELETE
/deployments/{deployment}
Delete Deployment
delete_deployment 2 params → 202501400403404409500503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are HandlerMetadata (15 properties), ServiceMetadata (14 properties), RegisterDeploymentResponse (5 properties), ServiceNameRevPair (2 properties). Each schema is shown below with its type and property counts.

UpdateDeploymentRequest
ServiceType
string
HandlerMetadataType
string
LambdaARN
string
HandlerMetadata
object
15 properties 3 required
RegisterDeploymentRequest
ServiceMetadata
object
14 properties 6 required
DetailedDeploymentResponse
DeploymentResponse
ProtocolType
string
RegisterDeploymentResponse
object
5 properties 2 required
ErrorDescriptionResponse
object
Error details of the response
2 properties 1 required
String
string
ListDeploymentsResponse
object
1 property 1 required
ServiceNameRevPair
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

restate-deployment-api-openapi.yml Raw ↑

Other APIs Restate publishes across the network.

Restate cluster_health API
Restate health API
Restate invocation API
Restate openapi API
Restate service API
Restate service_handler API
Restate subscription API
Restate version API