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 service API

Service management

Restate service 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 service. 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 4 paths, and defines 8 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 4 paths 8 schemas 3 GET1 PATCH1 POST

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 4 paths, the API surfaces 5 operations — 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

service 5

Service management

GET
/services
List Services
list_services → 200400403404409500503
GET
/services/{service}
Get Service
get_service 1 param → 200400403404409500503
PATCH
/services/{service}
Modify A Service
modify_service 1 param body → 200400403404409500503
GET
/services/{service}/openapi
Get Service OpenAPI
get_service_openapi 1 param → 200400403404409500503
POST
/services/{service}/state
Modify A Service State
modify_service_state 1 param body → 202400403404409500503

Schemas 8

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

ServiceType
string
HandlerMetadataType
string
HandlerMetadata
object
15 properties 3 required
ModifyServiceRequest
object
5 properties
ServiceMetadata
object
14 properties 6 required
ModifyServiceStateRequest
object
3 properties 2 required
ListServicesResponse
object
1 property 1 required
ErrorDescriptionResponse
object
Error details of the response
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

restate-service-api-openapi.yml Raw ↑

Other APIs Restate publishes across the network.

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