RIrivet-dev
actors::reschedule

Moves an actor to a new allocation. A running or stopping actor is stopped and allocated again, and a sleeping actor is allocated now. An actor that is still starting, or is destroyed, is left as is. The request body is ignored.

Changed on
post/actors/{actor_id}/reschedule

Request

  • Base URL
    https://api.rivet.dev
  • URL
    https://api.rivet.dev/actors/{actor_id}/reschedule
  • Auth
    • HTTP bearer
    • or API key in header x-rivet-token

Path parameters

actor_idstring required

A Rivet ID: 30 lowercase base36 characters.

Example:d97pbq1nyqxw1w5qdwz0iirbqiblh2

ID of the actor.

Query parameters

namespacestring

Name of the namespace to operate in. Defaults to default.

Response

The reschedule was accepted, or there was nothing to move.

ActorsRescheduleResponse required

Changes

  • aa8d1a8a5d14Revision changes
    • breaking

      removed the request body

    • breaking

      added the pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ to the query request parameter namespace

    • warning

      for the query request parameter namespace, the maxLength was set to 63

    • info

      the endpoint scheme security rivet_token_header was added to the API

    • info

      the query request parameter namespace became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • fd4e3ff41c93Revision changes
    • info

      endpoint added