You can view the service versions and service version details. You can also use the CLI command to import services from vFabric Application Director 5.0 and 5.2 versions to the Application Services 6.1 appliance or between different Application Services 6.0 appliances.

Service Version

Retrieves a paginated list of service versions.

All of the Application Services roles can access this API.

HTTP Method

GET

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/service-version?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/service-version?page=0&page-size=1

Response

{
  "errors": false,
  "messageList": [],
  "count": 22,
  "results": [
    {
      "id": "202",
      "lockVersion": 1,
      "name": "MySQL",
      "description": "MySQL 5.0\MySQL is the most popular open-source database system.",
      "version": {
        "major": "5",
        "minor": "0",
        "micro": "0",
        "qualifier": ""
      },
      "properties": [
        {
          "propertyDefinition": {
            "id": "900",
            "lockVersion": 0,
            "name": null,
            "description": null,
            "key": "global_conf",
            "type": "CONTENT",
            "secure": false,
            "required": true
          },
          "value": "https://192.0.2.255:8443/darwin/conf/darwin_global.conf",
          "overrideable": false
        },
[…]
      ],
      "scripts": [
        {
          "id": "2",
          "lockVersion": 1,
          "lifecycleStage": "INSTALL",
          "scriptType": "Bash Script",
          "script": "#!/bin/bash\n# I[… cut script …]\n",
          "rebootAfter": false
        },
[…]
      ],
      "groupMembership": {
        "id": "402",
        "lockVersion": 1,
        "ownerGroupRef": {
          "uri": null,
          "id": "1",
          "name": "Default"
        }
      }
    }
  ]
}

Service Version Details

Retrieves the service version details 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/service-version/ServiceVersionID

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/service-version/297

Response

{
  "errors": false,
  "messageList": [],
  "result": {
    "id": "297",
    "lockVersion": 1,
    "name": "Microsoft IIS with .Net Framework on W2K8R2",
    "description": "Install and enable IIS Server 7 and .Net Framework 3.5 on Windows Server 2008 R2.",
    "version": {
      "major": "1",
      "minor": "0",
      "micro": "0",
      "qualifier": ""
    },
    "properties": [
      {
        "propertyDefinition": {
          "id": "806",
          "lockVersion": 0,
          "name": null,
          "description": null,
          "key": "Install_Path",
          "type": "COMPUTED",
          "secure": false,
          "required": false
        },
        "value": "",
        "overrideable": false
      }
    ],
    "scripts": [
      {
        "id": "109",
        "lockVersion": 1,
        "lifecycleStage": "INSTALL",
        "scriptType": "Windows Powershell Script",
        "script": "import-module Servermanager\nAdd-WindowsFeature Net-Framework\nAdd-WindowsFeature web-asp-net\nAdd-WindowsFeature Web-Static-Content\nAdd-WindowsFeature as-http-activation\nAdd-WindowsFeature web-mgmt-tools\n#Set Install Path to the default install path (for monitoring)\n$Install_Path=\"${env:SYSTEMROOT}\\System32\"\necho \"Install_Path is set to $Install_Path, please modify this script if the install path is not correct.\"\n",
        "rebootAfter": false
      }
    ],
    "groupMembership": {
      "id": "433",
      "lockVersion": 1,
      "ownerGroupRef": {
        "uri": null,
        "id": "1",
        "name": "Default"
      }
    }
  }
}

Create Service Version

Creates the service version.

HTTP Method

POST

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/service-version

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/service-version

Request

{
    "id": "",
    "lockVersion": 0,
    "name": "test service",
    "description": "",
    "version": {
        "major": "1",
        "minor": "0",
        "micro": "0",
        "qualifier": ""
    },
    "tags": [
        {
            "id": "12",
            "lockVersion": 1,
            "name": "Other",
            "description": "Miscellaneous",
            "type": "Server Type"
        }
    ],
    "properties": [],
    "scripts": [
        {
            "id": "",
            "lockVersion": 0,
            "lifecycleStage": "INSTALL",
            "scriptType": "Bash Script",
            "script": "echo",
            "rebootAfter": false
        }
    ],
    "groupMembership": {
        "id": "",
        "lockVersion": 0,
        "ownerGroupRef": {
            "uri": null,
            "id": "4",
            "name": "Development"
        },
        "global": false
    },
    "contentType": null
}

Response

{
  "errors": false,
  "messageList": [
    {
      "messageType": "INFO",
      "message": "Service version saved successfully.",
      "messageKey": "service.version.save.msg",
      "property": null
    }
  ],
  "result": {
    "id": "60009",
    "lockVersion": 1,
    "name": "test service",
    "description": "",
    "version": {
      "major": "1",
      "minor": "0",
      "micro": "0",
      "qualifier": ""
    },
    "tags": [
      {
        "id": "12",
        "lockVersion": 1,
        "name": "Other",
        "description": "Miscellaneous",
        "lastUpdated": 1409163052291,
        "lastUpdateUser": "SYSTEM",
        "created": 1409163052291,
        "createUser": "SYSTEM",
        "type": "Server Type"
      }
    ],
    "properties": [],
    "scripts": [
      {
        "id": "1012018",
        "lockVersion": 0,
        "lifecycleStage": "INSTALL",
        "scriptType": "Bash Script",
        "script": "echo",
        "rebootAfter": false
      }
    ],
    "groupMembership": {
      "id": "437012",
      "lockVersion": 0,
      "ownerGroupRef": {
        "uri": null,
        "id": "4",
        "name": "Development"
      },
      "global": false
    },
    "contentType": null
  }
}

Update Service Version

Updates the existing service version with the new version.

HTTP Method

POST

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/service-version

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/service-version

Request

{
    "id": "60009",
    "lockVersion": 2,
    "name": "test service",
    "description": "",
    "version": {
        "major": "1",
        "minor": "0",
        "micro": "0",
        "qualifier": ""
    },
    "tags": [
        {
            "id": "12",
            "lockVersion": 1,
            "name": "Other",
            "description": "Miscellaneous",
            "lastUpdated": 1409163052291,
            "lastUpdateUser": "SYSTEM",
            "created": 1409163052291,
            "createUser": "SYSTEM",
            "type": "Server Type"
        }
    ],
    "properties": [
        {
            "propertyDefinition": {
                "id": "",
                "lockVersion": 0,
                "name": "",
                "description": null,
                "key": "property",
                "type": "STRING",
                "secure": false,
                "required": false
            },
            "value": "abc",
            "overrideable": false,
            "listValues": ""
        }
    ],
    "scripts": [
        {
            "id": "1012018",
            "lockVersion": 0,
            "lifecycleStage": "INSTALL",
            "scriptType": "Bash Script",
            "script": "echo",
            "rebootAfter": false
        }
    ],
    "groupMembership": {
        "id": "437012",
        "lockVersion": 0,
        "ownerGroupRef": {
            "uri": null,
            "id": "4",
            "name": "Development"
        },
        "global": false
    },
    "contentType": null
}

Response

{
  "errors": false,
  "messageList": [
    {
      "messageType": "INFO",
      "message": "Service version saved successfully.",
      "messageKey": "service.version.save.msg",
      "property": null
    }
  ],
  "result": {
    "id": "60009",
    "lockVersion": 3,
    "name": "test service",
    "description": "",
    "version": {
      "major": "1",
      "minor": "0",
      "micro": "0",
      "qualifier": ""
    },
    "tags": [
      {
        "id": "12",
        "lockVersion": 1,
        "name": "Other",
        "description": "Miscellaneous",
        "lastUpdated": 1409163052291,
        "lastUpdateUser": "SYSTEM",
        "created": 1409163052291,
        "createUser": "SYSTEM",
        "type": "Server Type"
      }
    ],
    "properties": [
      {
        "propertyDefinition": {
          "id": "170196",
          "lockVersion": 2,
          "name": "",
          "description": null,
          "key": "property",
          "type": "STRING",
          "secure": false,
          "required": false
        },
        "value": "abc",
        "overrideable": false,
        "listValues": ""
      }
    ],
    "scripts": [
      {
        "id": "1012018",
        "lockVersion": 2,
        "lifecycleStage": "INSTALL",
        "scriptType": "Bash Script",
        "script": "echo",
        "rebootAfter": false
      }
    ],
    "groupMembership": {
      "id": "437012",
      "lockVersion": 0,
      "ownerGroupRef": {
        "uri": null,
        "id": "4",
        "name": "Development"
      },
      "global": false
    },
    "contentType": null
  }
}

Delete Service Version

Removes the existing service version.

HTTP Method

DELETE

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/service-version/ServiceVersionID

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/service-version/60009

Response

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