The sample shows the POST /environments
operation to create a new environment associated with the organization encoded in the access token. In the request body, the name
, region
, and type
attributes are required. The value of the name
attribute must be unique within the organization. The billOfMaterials
attribute allows you to specify the Ping products associated with this environment.
If you set the type
attribute to PRODUCTION
, you cannot delete the environment until you reset the value to SANDBOX
. If you have a trial license, you cannot create PRODUCTION
environments or promote SANDBOX
environments to PRODUCTION
.
See Environments for important overview information.
Use Read all licenses to retrieve a list of all license IDs associated with the organization and select the specific environment’s licenseID
for the body. For more information, see Licenses.
For property descriptions, see Environments data model.
Property | Type | Required? |
---|---|---|
billOfMaterials |
Object | Optional |
billOfMaterials.products[0] |
Array | Optional |
billOfMaterials.products[0].id |
String | Required |
billOfMaterials.products[0].type |
String | Optional |
billOfMaterials.products[0].description |
String | Optional |
billOfMaterials.products[0].console |
String | Optional |
billOfMaterials.products[0].softwareLicense.id |
String | Optional |
billOfMaterials.products[0].deployment.id |
String | Optional |
description |
String | Optional |
icon |
String | Optional |
license.id |
String | Required |
name |
String | Required |
organization.id |
String | Optional |
region |
String | Required |
type |
String | Required |