Application Environment

List application environments

Returns a list of environments for the specified application

get/v2/application/{organization}/{project}/{application}/environment

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/application/{organization}/{project}/{application}/environment
  • Auth: HTTP bearer

Path parameters

organizationstring required

Organization name (slug)

Example:zephyr-cloud
projectstring required

Project name (slug)

Example:main-app
applicationstring required

Application name (slug)

Example:web-dashboard

Query parameters

sortBy'name' | 'version' | 'updatedAt'

Sort field

sortOrder'asc' | 'desc'

Sort order

querystring

Filter query in format <field>:<value>

Example:name:production

Response

List of environments

Example response

{
  "entities": [
    {
      "version": {
        "id": "ver-123",
        "name": "1.0.0",
        "remote_host": "https://app.zephyr-cloud.io",
        "remote_entry_url": "https://app.zephyr-cloud.io/remoteEntry.js"
      },
      "condition": {
        "channel": "tag",
        "value": {
          "value": "production",
          "label": "Production"
        }
      },
      "author": {
        "id": "user-123",
        "name": "Jane Smith",
        "email": "jane@example.com",
        "portrait": "https://avatars.example.com/jane.jpg",
        "username": "janesmith",
        "avatarColor": "#e74c3c"
      },
      "context": {
        "username": "deploy-bot",
        "isCI": true
      }
    }
  ]
}

Changes

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