You can view the associated deployment environments to a cloud provider. You can also use the APIs to manage these deployment environments.

Get Deployment Environments

Retrieves a paginated list of deployment environments.

All of the Application Services roles can access this API.

HTTP Method

GET

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment?page=Page&page-size=PageSize

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment?page=0&page-size=10

Response

{
  "errors": false,
  "messageList": [],
  "count": 1,
  "results": [
    {
      "id": "1",
      "lockVersion": 4,
      "name": "DE",
      "description": "QA Deployment Environment",
      "lastUpdated": 1378765277632,
      "lastUpdateUser": "admin",
      "created": 1378765102894,
      "createUser": "admin",
      "cloudProviderRef": {
        "uri": "/darwin/api/2.0/cloud-provider/1",
        "id": "1",
        "name": "Cloud"
      },
      "properties": [
        {
          "propertyDefinition": {
            "id": "1024",
            "lockVersion": 0,
            "name": "VDC URI",
            "description": "Virtual Data Center URI",
            "key": "vdc_uri",
            "type": "STRING",
            "secure": false,
            "required": false
          },
          "value": "https://192.0.2.255/api/vdc/a2079642-0bde-42e5-8646-7a333618355b",
          "overrideable": false
        }
      ]
    }
  ]
}

Get Deployment Environment

Retrieves the deployment environment based on the provided identification.

All of the Application Services roles can access this API.

HTTP Method

GET

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment/DeploymentEnvironmentID

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment/1

Response

{
  "errors": false,
  "messageList": [],
  "result": {
    "id": "1",
    "lockVersion": 4,
    "name": "DE",
    "description": "QA Deployment Environment",
    "lastUpdated": 1378765277632,
    "lastUpdateUser": "admin",
    "created": 1378765102894,
    "createUser": "admin",
    "cloudProviderRef": {
      "uri": "/darwin/api/2.0/cloud-provider/1",
      "id": "1",
      "name": "Cloud"
    },
    "properties": [
      {
        "propertyDefinition": {
          "id": "1024",
          "lockVersion": 0,
          "name": "VDC URI",
          "description": "Virtual Data Center URI",
          "key": "vdc_uri",
          "type": "STRING",
          "secure": false,
          "required": false
        },
        "value": "https://192.0.2.255/api/vdc/a2079642-0bde-42e5-8646-7a333618355b",
        "overrideable": false
      }
    ]
  }
}

Create Deployment Environment

Creates a deployment environment.

The application cloud administrator can access this API.

HTTP Method

POST

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment

Request

{
    "id": "0",
    "lockVersion": 0,
    "name": "New DE",
    "description": "Deployment Environment",
    "cloudProviderRef": {
      "uri": "/darwin/api/2.0/cloud-provider/1",
      "id": "1",
      "name": "Cloud"
    },
    "properties": [
      {
        "propertyDefinition": {
          "id": "1024",
          "lockVersion": 0,
          "name": "VDC URI",
          "description": "Virtual Data Center URI",
          "key": "vdc_uri",
          "type": "STRING",
          "secure": false,
          "required": false
        },
        "value": "https://192.0.2.255/api/vdc/a2079642-0bde-42e5-8646-7a333618355b",
        "overrideable": false
      }
    ]
  }

Response

{
  "errors": false,
  "messageList": [
    {
      "messageType": "INFO",
      "message": "Deployment Environment saved successfully.",
      "messageKey": "deploymentEnvironment.save.msg",
      "property": null
    }
  ],
  "result": {
    "id": "2",
    "lockVersion": 1,
    "name": "New DE",
    "description": "Deployment Environment",
    "lastUpdated": 1378935302738,
    "lastUpdateUser": "admin",
    "created": 1378935302737,
    "createUser": "admin",
    "cloudProviderRef": {
      "uri": "/darwin/api/2.0/cloud-provider/1",
      "id": "1",
      "name": "Cloud"
    },
    "properties": [
      {
        "propertyDefinition": {
          "id": "1024",
          "lockVersion": 0,
          "name": "VDC URI",
          "description": "Virtual Data Center URI",
          "key": "vdc_uri",
          "type": "STRING",
          "secure": false,
          "required": false
        },
        "value": "https://192.0.2.255/api/vdc/a2079642-0bde-42e5-8646-7a333618355b",
        "overrideable": false
      }
    ]
  }
}

Get Deployment Environment Property Values

Retrieves the property value definitions of a deployment environment associated to a cloud provider.

The application cloud administrator can access this API.

HTTP Method

GET

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/cloud-provider/CloudProviderID/de-property-value-choices/Key

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationServicesServerIP:8443/darwin/api/2.0/cloud-provider/3/de-property-value-choices/reservation_policy_uri

Response

{
    "errors": false,
    "messageList": [],
    "count": 5,
    "results": [
        "vcac://auto",
        "vcac://rp/3f98e478-f941-4aeb-ae4a-3cc77df908d3",
        "vcac://rp/b942ab8d-10ff-41c2-b4e8-777c89e3cfbc",
        "vcac://rp/4443368b-8246-4194-9dd3-d4aecdd06996",
        "vcac://rp/0d73b1a2-effc-4ec0-bd25-d4b20dbfdf06"
    ]
}

Get Cloud Storage

Retrieves a list of cloud storage associated to a deployment environment.

The application cloud administrator can access this API.

HTTP Method

GET

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment/DeploymentEnvironmentID/cloud-storage

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment/3/cloud-storage

Response

{
    "errors": false,
    "messageList": [],
    "count": 1,
    "results": [
        {
            "id": "0",
            "lockVersion": 0,
            "name": "gold",
            "description": null,
            "cloudStorageExtref": {
                "id": "vcac://sp/964185d6-3f40-44e0-9743-be5eed5528e1",
                "name": "gold"
            },
            "properties": []
        }
    ]
}

Get Cloud Network

Retrieves a list of cloud networks associated to a deployment environment.

The application cloud administrator can access this API.

HTTP Method

GET

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment/DeploymentEnvironmentID/cloud-network

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment/24/cloud-network

Response

{
    "errors": false,
    "messageList": [],
    "count": 2,
    "results": [
        {
            "id": "0",
            "lockVersion": 0,
            "name": "AppDir-Direct",
            "description": null,
            "cloudNetworkExtref": {
                "id": "https://vcd-server-bat-3.test.com/api/admin/network/548d8ee5-2459-42b4-affc-920e8292f1c3",
                "name": "AppDir-Direct"
            },
            "properties": [
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "isolated",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "false",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "routed",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "false",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "gatewayIp",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "192.0.2.255.253",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "pool",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "true",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "bridged",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "true",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "dhcp",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "false",
                    "overrideable": false
                }
            ]
        },
        {
            "id": "0",
            "lockVersion": 0,
            "name": "Test-Routed",
            "description": null,
            "cloudNetworkExtref": {
                "id": "https://vcd-server-bat-3.test.com/api/admin/network/124f244a-c3b4-4b0f-98c8-dbab4e95905e",
                "name": "Test-Routed"
            },
            "properties": [
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "isolated",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "false",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "routed",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "true",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "gatewayIp",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "192.0.2.255",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "pool",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "true",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "bridged",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "false",
                    "overrideable": false
                },
                {
                    "propertyDefinition": {
                        "id": null,
                        "lockVersion": 0,
                        "name": null,
                        "description": null,
                        "key": "dhcp",
                        "type": null,
                        "secure": false,
                        "required": false
                    },
                    "value": "false",
                    "overrideable": false
                }
            ]
        }
    ]
}

Delete Deployment Environment

Deletes the deployment environment associated to a cloud provider.

The application cloud administrator can access this API.

HTTP Method

DELETE

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment/DeploymentEnvironmentID

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationServicesServerIP:8443/darwin/api/2.0/deployment-environment/2

Response

{
  "errors": false,
  "messageList": [
    {
      "messageType": "INFO",
      "message": "Successfully deleted Deployment Environment.",
      "messageKey": "delete.msg",
      "property": null
    }
  ]
}