phpExt / Postman API / Create Environment
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "environment": {
// "name": "Sample Environment Name (required)",
// "values": [
// {
// "key": "variable_name_1",
// "value": "The value of the variable"
// },
// {
// "key": "variable_name_2",
// "value": ""
// }
// ]
// }
// }
$json = new CkJsonObject();
$json->UpdateString('environment.name','Sample Environment Name (required)');
$json->UpdateString('environment.values[0].key','variable_name_1');
$json->UpdateString('environment.values[0].value','The value of the variable');
$json->UpdateString('environment.values[1].key','variable_name_2');
$json->UpdateString('environment.values[1].value','');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('X-API-Key','{{postman_api_key}}');
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://api.getpostman.com/environments','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "environment": {
// "id": "f158266e-306b-4702-a2b9-e4ede7878b7a",
// "name": "Sample Environment Name (required)",
// "uid": "5665-f158266e-306b-4702-a2b9-e4ede7878b7a"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Id = $jResp->stringOf('environment.id');
$Name = $jResp->stringOf('environment.name');
$Uid = $jResp->stringOf('environment.uid');
?>
Curl Command
curl -X POST
-H "X-API-Key: {{postman_api_key}}"
-H "Content-Type: application/json"
-d '{
"environment": {
"name": "Sample Environment Name (required)",
"values": [
{
"key": "variable_name_1",
"value": "The value of the variable"
},
{
"key": "variable_name_2",
"value": ""
}
]
}
}'
https://api.getpostman.com/environments
Postman Collection Item JSON
{
"name": "Create Environment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"environment\": {\n \"name\": \"Sample Environment Name (required)\",\n \"values\": [\n {\n \"key\": \"variable_name_1\",\n \"value\": \"The value of the variable\"\n },\n {\n \"key\": \"variable_name_2\",\n \"value\": \"\"\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.getpostman.com/environments",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
]
},
"description": "A sample body is added to the request that conforms to the following JSON schema:\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 254,\n \"minLength\": 1\n },\n \"values\": {\n \"type\": \"array\",\n \"maxItems\": 100,\n \"additionalItems\": false,\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"key\": {\n \"type\": \"string\",\n \"maxLength\": 254\n \"minLength\": 1\n },\n \"value\": { \"type\": \"string\" },\n \"enabled\": { \"type\": \"boolean\" }\n },\n \"required\": [\"key\", \"value\"]\n }\n }\n },\n \"required\": [\"name\"]\n }\n },\n \"required\": [\"environment\"]\n}\n```\n\nOn successful creation of the environment, the API returns the environment name and `id`.\n\nYou can also specify the context of a workspace to create an environment in directly by passing the `workspace` as a query param.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Create Environment in a Workspace",
"originalRequest": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"environment\": {\n \"name\": \"Sample Environment Name (required)\",\n \"values\": [\n {\n \"key\": \"variable_name_1\",\n \"value\": \"The value of the variable\"\n },\n {\n \"key\": \"variable_name_2\",\n \"value\": \"\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.getpostman.com/environments?workspace={{workspace_id}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
],
"query": [
{
"key": "workspace",
"value": "{{workspace_id}}",
"description": "The workspace ID in which the environment will be created"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"environment\": {\n \"id\": \"f158266e-306b-4702-a2b9-e4ede7878b7a\",\n \"name\": \"Sample Environment Name (required)\",\n \"uid\": \"5665-f158266e-306b-4702-a2b9-e4ede7878b7a\"\n }\n}"
},
{
"name": "Successful Response",
"originalRequest": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"environment\": {\n \"name\": \"Sample Environment Name (required)\",\n \"values\": [\n {\"key\": \"variable_name_1\", \"value\": \"The value of the variable\"},\n {\"key\": \"variable_name_2\", \"value\": \"\"}\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.getpostman.com/environments",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"environment\": {\n \"id\": \"f158266e-306b-4702-a2b9-e4ede7878b7a\",\n \"name\": \"Sample Environment Name (required)\",\n \"uid\": \"5665-f158266e-306b-4702-a2b9-e4ede7878b7a\"\n }\n}"
},
{
"name": "Failure Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \n}"
},
"url": {
"raw": "https://api.getpostman.com/environments",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"cookie": [
],
"body": "{\n \"error\": {\n \"name\": \"malformedRequestError\",\n \"message\": \"Found 1 errors with the supplied environment.\",\n \"details\": [\n \": must have required property 'environment'\"\n ]\n }\n}"
}
]
}
