ACacquia
Environments

Retrieves details for an environment by codebase and environment ID.

get/codebases/{codebaseId}/environments/{environmentId}

Request

Path parameters

codebaseIdstring required

Codebase identifier

environmentIdstring required

Unique identifier for the environment.

Response

Environment details

idstring required

The unique identifier of the environment

namestring required

The machine name of the environment

labelstring required

The human-readable label of the environment

descriptionstring

A description of the environment

status'normal' | 'allocated' | 'launching' | 'killed' | 'cancelled' | 'stopped' required

The current status of the environment

flagsobject required

Environment configuration flags

referencestring required

The code reference (branch, tag, or commit) deployed to this environment

code_switch_status'IDLE' | 'IN_PROGRESS' required

The status of the Switch Code action

ssh_urlstring uri required

The SSH connection string for accessing this environment

regionstring

The cloud region where this environment is hosted

domain_namestring required

The default domain for this environment

Example response

{
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  },
  "_embedded": {
    "codebase": {
      "_links": {
        "self": {
          "href": "https://api.acquia.com/v3/resources/1"
        }
      }
    }
  }
}

Changes

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