POST /api/deployment/group/configuration/{groupID}

Description

Called by the client application to upload a new configuration (Deployment Archive) to all hosts that run API Servers in the group that this configuration is destined for. This method must be called before the client can invoke the Configuration API in the API Servers (via Node Manager) to load the new configuration.

The steps for deployment to a group of API Servers are as follows:-

Step 1: Upload Deployment Archive to all hosts running API Servers in the group, i.e. invoke the method described here.

Step 2: Invoke the Configuration API method PUT /api/configuration?archiveId={archiveId} on each API Server in the group via the Routing API in the Node Manager to get the API Server to load the new configuration.


Resource URL

https://localhost:8090/api/deployment/group/configuration/{groupID}


Parameters

groupID mandatory The id of the group that this configuration is destined for.
archive mandatory The Deployment Archive containing the new configuration. This is passed in the request body. Refer to Javadoc for com.vordel.api.deployment.model.DeploymentArchive.

Response Codes

Response Code Description
204 Success. 204 indicates a successful upload of the configuration to all required hosts.
500 The response contains an error e.g. a failure occurred writing to disk, or calling a remote Node Manager.

Example Request and Response

POST https://localhost:8090/api/deployment/group/configuration/group-2

{
    "rootProperties": {
        "Id": "5abfa6cc-39bb-40ec-b089-82f003ee9ff4",
        "Timestamp": "1355223821144"
    },
    "policyProperties": {
        "Name": "My Test Configuration",
        "Description": "Testing config for payment services",
        "Version": "v2",
        "VersionComment": "Add SSL"
    },
    "environmentProperties": {
        "Name": "Testing Environment Settings",
        "Description": "Testing environment settings for payment services",
        "Version": "v4",
        "VersionComment": "Add SSL ports"
    },
    "data": "UEsDBBQACAAIAHRYi0EAAAAAAAAAAAAAAAAUAAQATUVUQS1JTkYvTUFO....."
}

HTTP 1.1 204 No Content