RIrivet-dev
metadata

Returns the runtime and version of the control plane. Requests with the admin token also receive the actor names served by the default namespace.

Changed on
get/metadata

Request

  • Base URL
    https://api.rivet.dev
  • URL
    https://api.rivet.dev/metadata
  • Auth
    • none
    • or HTTP bearer
    • or API key in header x-rivet-token

Response

Runtime and version metadata.

runtime'engine' required

Always engine.

versionstring required

Version of the control plane.

envoyProtocolVersioninteger required

Version of the protocol nodes use to connect to the control plane.

actorNamesobject

Actor names the default namespace's connected nodes accept. Only present for requests made with the admin token.

Changes

  • aa8d1a8a5d14Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new engine enum value to the response property for the response status

    • info

      the endpoint scheme security bearer_auth was added to the API

    • info

      the endpoint scheme security rivet_token_header was added to the API

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 16af2454889cRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status