CI & Test Runs

List the environments of a project

Returns the environments of a project, so a pipeline can pick the one whose variables the run should use. An environment marked isReadOnly rejects every write request sent to it, and the test cases concerned are reported as blocked rather than failed.

get/api/cli/environments

Request

  • Base URL: https://api.routebase.dev
  • URL: https://api.routebase.dev/api/cli/environments
  • Auth: API key in header X-API-Key

Query parameters

ProjectIdQuerystring uuid required

Public id of the project.

Headers

X-RB-Regionstring
Example:us

Region of your organization. US organizations must send us; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.

Response

The environments of the project.

idstring uuid required

Public id of the environment.

namestring required

Display name of the environment, such as Staging.

type'development' | 'staging' | 'production' | 'custom' required

The stage an environment stands for.

baseUrlstring nullable

Base URL requests in this environment are sent to.

createdAtstring date-time required

When the environment was created, in UTC.

variableCountinteger required

How many variables the environment defines for substitution.

freezesVersionboolean

A promotion into this environment makes the promoted version immutable.

isDocsSourceboolean

What this environment pins is what the public documentation shows.

isMockSourceboolean

What this environment pins is what the mock server serves.

isReadOnlyboolean

Only GET, HEAD and OPTIONS may be sent here. Test cases that write are reported as blocked rather than run.

Changes

No recorded changes to this operation across all 1 revision of this API.