Sign In
API

routes.list

Description

Lists all routes of the given environment.

Code Examples

curl -X GET 'https://api.rivet.gg/routes'

Schema

Request Parameters

  • project
    nullable string query parameter
  • environment
    nullable string query parameter

Response

  • routes
    array of objects
    • routes[].id
      string
    • routes[].created_at
      string

      RFC3339 timestamp

    • routes[].updated_at
      string

      RFC3339 timestamp

    • routes[].hostname
      string
    • routes[].path
      string
    • routes[].route_subpaths
      boolean

      Whether to route all subpaths of this path

    • routes[].strip_prefix
      boolean

      Whether to remove the path prefix before sending the request to the target.

    • routes[].target
      object
      • routes[].target.actors
        nullable object

        Configuration for targeting actors.

        • routes[].target.actors.selector_tags
          map

          Tags of actors to route requests to.

Suggest changes to this page