v1

latestOpenAPI 3.0.02026-07-249372139.7 KB
Environments

Environments

Update a single environment, If you want to update a child environment, set the Parent Environment, if not set to null

put/environments/{EnvironmentID}

Path parameters

EnvironmentIDinteger required

ID of Environment

Request body

Namestring required
Descriptionstring required
Parentstring nullable required
Tier'Core' | 'Essential'
Statusinteger required

Example request

{
  "Name": "Test new name 2",
  "Description": "This is an edit test",
  "Parent": null,
  "Status": 1
}

Response

IDinteger
ServiceProviderIDinteger
Namestring
ShortNamestring
Descriptionstring
Statusinteger
Visibleboolean
ExpiresOnstring
KeyRotationinteger
Websitestring
Staticboolean
CreatedOnstring
UpdatedOnstring

Example response

{
  "ID": 8888,
  "ServiceProviderID": 1,
  "Name": "Contoso Nation",
  "ShortName": "CN",
  "Description": "Example Description",
  "Status": 1,
  "Visible": true,
  "ExpiresOn": "2021-09-10T19:21:03.195Z",
  "KeyRotation": 90,
  "Website": "contoso.com",
  "CreatedOn": "2021-09-10T19:21:03.195Z",
  "UpdatedOn": "2021-09-10T19:21:03.195Z",
  "Tier": {
    "Type": "Core",
    "AssociatedInspectors": 14
  },
  "CreatedBy": {
    "ID": 1234,
    "FirstName": "Alex",
    "LastName": "Weber",
    "Username": "Alex.Weber"
  }
}