Project Groups

Changed on
post/project-groups/{group_id}/routes

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/project-groups/{group_id}/routes
  • Auth: HTTP bearer

Path parameters

group_idinteger required

Project group ID

Request body

path_prefixstring required

Path prefix handed to the target, e.g. /api. Matches the prefix itself and everything below it (/api/users), never /apiary.

source_project_idinteger required

The service whose hostnames receive the requests.

strip_prefixboolean

Remove the prefix before forwarding (/api/users → /users). Off by default: most backends expect the path they were called with.

target_project_idinteger required

The service that serves requests under the prefix.

Example request

{
  "path_prefix": "/api"
}

Response

Route created; the proxy applies it within seconds, no redeploy needed

created_atstring date-time required
group_idinteger required
idinteger required
path_prefixstring required
source_project_idinteger required
source_project_namestring required
strip_prefixboolean required
target_project_idinteger required
target_project_namestring required

Example response

{
  "created_at": "2026-09-28T12:15:47.609192Z",
  "environments": [
    {
      "source_environment_slug": "production"
    }
  ],
  "path_prefix": "/api"
}

Changes