inactivateEnvironment

Format

udclient [global-args...] [global-flags...]
  inactivateEnvironment [parameters]

Parameters

Table 1. Parameters
Parameter Type Required Description
environment string true Name or ID of the environment to look up
application string false Name of the application - required if using environment name instead of ID.

Example

udclient -username admin -password admin 
  -weburl https://myserver.example.com:8443
  inactivateEnvironment 
  -application JPetStore 
  -environment NewEnvironment

Example response

{
  "id": "de724d57-5bfc-44bf-af32-989295357da7",
  "name": "NewEnvironment",
  "color": "#ffffff",
  "requireApprovals": false,
  "lockSnapshots": false,
  "calendarId": "f4b384f8-9c5a-4bb3-b8b2-e1c6325042d2",
  "active": false,
  "cleanupDaysToKeep": 0,
  "cleanupCountToKeep": 0,
  "conditions": [
  ],
  "compliancy": {
    "missingCount": 0,
    "correctCount": 0,
    "desiredCount": 0
  },
  "systemCleanupDaysToKeep": -1,
  "systemCleanupCountToKeep": -1,
  "exemptProcesses": "",
  "extendedSecurity": {
    "read": true,
    "write": true,
    "execute": true,
    "Create Environments": true,
    "Edit Environments": true,
    "Execute on Environments": true,
    "View Environments": true,
    "teams": [
      {
        "teamId": "ea307e2e-d6be-4092-a7e8-e8e02274de7e",
        "teamLabel": "My team"
      }
    ]
  }
}

Related REST command: /environment/inactivateEnvironment PUT.


Feedback