Get Environment Status

Gets the status of the specified agency environment. If the environment is unavailable or has been disabled on the Construct Admin Portal, "isAvailable":"false" is returned. If Accela Gateway is unreachable, the Get Environment Status API returns 500.

Resource Information

Scope agencies

Deprecated scope name:   get_agencies_environments_status
App Type All
Authorization Type No authorization required
URI /v4/agencies/{name}/environments/{env}/status
HTTP Method GET
Automation Version(s) All

Request Information

Field or Parameter Type Required Values Description Automation Version
env string Yes   The name of the environment to check.  All
name string Yes   The name of the object to be queried. All

Example

Sample Request

GET https://apis.accela.com/v4/agencies/ISLANDTON/environments/PROD/status

Response Information

Field Type Description Automation Version
result result{} Contains the environment status.  All
result.isAvailable boolean Indicates whether or not the requested environment is available. If the environment is unavailable or has been disabled on the Construct Admin Portal,"isAvailable":"false" is returned. All
status integer The return status. If Accela Gateway is unreachable, the Get Environment Status API returns 500. All

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "isAvailable": true
  }
}