Environment

Retrieves a Environment resource.

Retrieves a Environment resource.

get/v1/environments/{publicId}

Request

  • Base URL: https://api.fortrabbit.com
  • URL: https://api.fortrabbit.com/v1/environments/{publicId}
  • Auth: HTTP bearer

Path parameters

publicIdstring required

Environment identifier

Response

Environment resource

publicIdstring
namestring
softwareVersionstring nullable
createdAtstring date-time
updatedAtstring date-time
domainsstring[]
componentsobject
phpVersionstring nullable
buildCommandsstring[]
postDeployCommandsstring[]
environmentVariablesobject

Variables set on this environment by its owners, keyed by name.

platformVariablesobject

Variables injected by fortrabbit, keyed by name. Read-only: they cannot be added, changed or removed. Encrypted values, such as the database password, are not exposed.

Example response

{
  "environmentVariables": {
    "APP_ENV": "production"
  },
  "platformVariables": {
    "MYSQL_DATABASE": "app"
  }
}

Changes

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