Control Plane

Get Metadata

Get the runtime and version of the control plane.

A request made with the admin token also receives actorNames.

GET https://rivet.example.com/metadata

Examples

curl "https://rivet.example.com/metadata"

const endpoint = "https://api.rivet.dev";

const response = await fetch(`${endpoint}/metadata`);
const metadata = await response.json();
console.log(metadata);

export {};

Authentication

No authentication is required.

Responses

200

Runtime and version metadata.

Field	Type	Description
`runtime`	`"engine"`	Always `engine`.
`version`	`string`	Version of the control plane.
`envoyProtocolVersion`	`integer`	Version of the protocol nodes use to connect to the control plane.
`actorNames`	`object`	Actor names the default namespace’s connected nodes accept. Only present for requests made with the admin token.

{
  "runtime": "engine",
  "version": "<version>",
  "envoyProtocolVersion": 0,
  "actorNames": {}
}

500

core.internal_error: an unexpected failure. Details are only logged on the server.

Field	Type	Description
`group`	`string`	Error group, for example `actor`.
`code`	`string`	Error code within the group, for example `not_found`.
`message`	`string`	Human-readable error message.
`metadata`	`any`	Extra details. Only present on some errors raised while authenticating or authorizing the request.

{
  "group": "core",
  "code": "internal_error",
  "message": "An internal error occurred"
}