UploadController

Mapping of URIs that begin with /{version}/upload

A controller for uploading files for future deployments. Each uploaded file will be available for {@link CloudifyConstants#DEFAULT_UPLOAD_TIMEOUT_MILLIS} seconds. The timeout can be edited via {@link UploadRepo#setCleanupTimeoutMillis(int)}.

HTTP Methods

POST

Uploading a file to be used in future deployments. The file will be kept at least {@link UploadRepo#TIMEOUT_SECOND} seconds.

Parameters

Type Name Description Mandatory Parameter type Default value
String fileName The name of the file to upload true PathVariable
MultipartFile file The file to upload true RequestParam

Request

Request body for a POST on /{version}/upload/{fileName:.+}
"file's content"

Response

Response to a POST on /{version}/upload/{fileName:.+}
{
  "status" : "Success",
  "message" : "Operation completed successfully",
  "messageId" : "operation_successfull",
  "verbose" : null,
  "response" : {
    "uploadKey" : "9c7ea509-a461-48d6-82ef-36653c0cb6f4"
  }
}

TemplatesController

Mapping of URIs that begin with /{version}/templates

HTTP Methods

POST

Add templates from templates folder to the cloud. Returns a response in case of success or partial failure.

Parameters

Type Name Description Mandatory Parameter type Default value
AddTemplatesRequest request {@link AddTemplatesRequest} true RequestBody

Request

Request body for a POST on /{version}/templates
{
  "uploadKey" : "d5b8f201-f00d-428d-9ac6-98529e3bbd38"
}

Response

Response to a POST on /{version}/templates
{
  "status" : "PartialFailure",
  "message" : "partial failure - not all the expected templates were added to all REST instances.",
  "messageId" : "partly_failed_to_add_templates",
  "verbose" : {
    "templates" : {
      "SMALL_UBUNTU" : {
        "failedToAddHosts" : {
          "192.168.9.10" : "template already exists",
          "192.168.9.13" : "template already exists"
        },
        "successfullyAddedHosts" : [ "192.168.9.17" ]
      },
      "SMALL_SUSE" : {
        "failedToAddHosts" : { },
        "successfullyAddedHosts" : [ "192.168.9.13", "192.168.9.10", "192.168.9.17" ]
      },
      "SMALL_LINUX" : {
        "failedToAddHosts" : {
          "192.168.9.10" : "template already exists",
          "192.168.9.13" : "template already exists",
          "192.168.9.17" : "template already exists"
        },
        "successfullyAddedHosts" : [ ]
      }
    },
    "instances" : [ "192.168.9.13", "192.168.9.10", "192.168.9.17" ],
    "status" : "PARTIAL_FAILURE"
  },
  "response" : null
}

GET

Get the cloud's templates.

Request

Request body for a GET on /{version}/templates
request has no body

Response

Response to a GET on /{version}/templates
{
  "status" : "Success",
  "message" : "Operation completed successfully",
  "messageId" : "operation_successfull",
  "verbose" : null,
  "response" : {
    "templates" : {
      "MY_TEMPLATE_4" : {
        "imageId" : "eu-west-1/ami-c1aaabb5",
        "machineMemoryMB" : 1600,
        "hardwareId" : "m1.small",
        "locationId" : "eu-west-1",
        "localDirectory" : "upload",
        "keyFile" : "key-file.pem",
        "autoRestartAgent" : true,
        "numberOfCores" : 1,
        "options" : {
          "keyPair" : "key-pair-eu",
          "securityGroups" : [ "default" ]
        },
        "overrides" : { },
        "custom" : { },
        "fileTransfer" : "SFTP",
        "remoteExecution" : "SSH",
        "scriptLanguage" : "LINUX_SHELL",
        "username" : "my_template_4",
        "password" : null,
        "remoteDirectory" : "upload",
        "privileged" : true,
        "initializationCommand" : null,
        "javaUrl" : null,
        "absoluteUploadDir" : null,
        "env" : { },
        "installer" : {
          "connectionTestRouteResolutionTimeoutMillis" : 120000,
          "connectionTestIntervalMillis" : 5000,
          "connectionTestConnectTimeoutMillis" : 10000,
          "fileTransferConnectionTimeoutMillis" : 10000,
          "fileTransferRetries" : 3,
          "fileTransferPort" : -1,
          "fileTransferConnectionRetryIntervalMillis" : 5000,
          "remoteExecutionPort" : -1,
          "remoteExecutionConnectionTimeoutMillis" : 10000
        },
        "openFilesLimit" : null,
        "computeNetwork" : {
          "networks" : [ ]
        }
      }
    }
  }
}

HTTP Methods

GET

Get template from the cloud.

Parameters

Type Name Description Mandatory Parameter type Default value
String templateName The name of the template to get true PathVariable

Request

Request body for a GET on /{version}/templates/{templateName}
request has no body

Response

Response to a GET on /{version}/templates/{templateName}
{
  "status" : "Success",
  "message" : "Operation completed successfully",
  "messageId" : "operation_successfull",
  "verbose" : null,
  "response" : {
    "template" : {
      "imageId" : "eu-west-1/ami-c1aaabb5",
      "machineMemoryMB" : 1600,
      "hardwareId" : "m1.small",
      "locationId" : "eu-west-1",
      "localDirectory" : "upload",
      "keyFile" : "key-file.pem",
      "autoRestartAgent" : true,
      "numberOfCores" : 1,
      "options" : {
        "keyPair" : "key-pair-eu",
        "securityGroups" : [ "default" ]
      },
      "overrides" : { },
      "custom" : { },
      "fileTransfer" : "SFTP",
      "remoteExecution" : "SSH",
      "scriptLanguage" : "LINUX_SHELL",
      "username" : "my_template_0",
      "password" : null,
      "remoteDirectory" : "upload",
      "privileged" : true,
      "initializationCommand" : null,
      "javaUrl" : null,
      "absoluteUploadDir" : null,
      "env" : { },
      "installer" : {
        "connectionTestRouteResolutionTimeoutMillis" : 120000,
        "connectionTestIntervalMillis" : 5000,
        "connectionTestConnectTimeoutMillis" : 10000,
        "fileTransferConnectionTimeoutMillis" : 10000,
        "fileTransferRetries" : 3,
        "fileTransferPort" : -1,
        "fileTransferConnectionRetryIntervalMillis" : 5000,
        "remoteExecutionPort" : -1,
        "remoteExecutionConnectionTimeoutMillis" : 10000
      },
      "openFilesLimit" : null,
      "computeNetwork" : {
        "networks" : [ ]
      }
    }
  }
}

DELETE

Removes a template from the cloud.

Parameters

Type Name Description Mandatory Parameter type Default value
String templateName The name of the template to remove true PathVariable

Request

Request body for a DELETE on /{version}/templates/{templateName}
request has no body

Response

Response to a DELETE on /{version}/templates/{templateName}
response has no body

ServiceController

Mapping of URIs that begin with /service

HTTP Methods

GET

Returns a valid response if the user is fully authorized and has permissions for installing an application.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName the application name true PathVariable

Request

Request body for a GET on /service/application/{applicationName}/install/permissions
request has no body

Response

Response to a GET on /service/application/{applicationName}/install/permissions
{"status": "success"}

HTTP Methods

GET

Creates and returns a map containing all of the deployed application names.

Request

Request body for a GET on /service/applications
request has no body

Response

Response to a GET on /service/applications
{
  "status" : "success",
  "response" : [ "petclinic", "travel" ]
}

$response.getComments()

HTTP Methods

GET

Creates and returns a list containing all of the deployed application details.

Request

Request body for a GET on /service/applications/description
request has no body

Response

Response to a GET on /service/applications/description
{
  "status" : "success",
  "response" : [ "petclinic", "travel" ]
}

$response.getComments()

HTTP Methods

GET

Creates and returns a map containing all of the deployed service names installed under a specific application context.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName true PathVariable

Request

Request body for a GET on /service/applications/{applicationName}/services
request has no body

Response

Response to a GET on /service/applications/{applicationName}/services
{
  "status" : "sucess",
  "response" : [ "service1", "service2" ]
}

HTTP Methods

GET

Creates and returns a map containing all of the deployed service names installed under a specific application context.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName true PathVariable

Request

Request body for a GET on /service/applications/{applicationName}/services/description
request has no body

Response

Response to a GET on /service/applications/{applicationName}/services/description
{
  "status" : "sucess",
  "response" : [ "service1", "service2" ]
}

HTTP Methods

POST

Increments the Processing unit instance number of the specified service.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name where the service resides true PathVariable
String serviceName The service name true PathVariable
Map params map that holds a timeout value for this action true RequestBody

Request

Request body for a POST on /service/applications/{applicationName}/services/{serviceName}/addinstance
{
  "timeout" : 5,
  "authGroups" : "myAuthGroups"
}

Response

Response to a POST on /service/applications/{applicationName}/services/{serviceName}/addinstance
{"status": "success"}

HTTP Methods

GET

Retrieves the tail of a service log. This method uses the service name and the instance host address to retrieve the instance log tail. Important: a machine might hold more than one service instance. In such a scenario, only one of the service instance logs will be tailed and returned.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name true PathVariable
String serviceName The service name true PathVariable
String hostAddress The service instance's host address true PathVariable
int numLines The number of lines to tail true RequestParam

Request

Request body for a GET on /service/applications/{applicationName}/services/{serviceName}/address/{hostAddress}/tail
{
  "numLines" : 10
}

Response

Response to a GET on /service/applications/{applicationName}/services/{serviceName}/address/{hostAddress}/tail
{
  "status" : "success",
  "response" : "numLines lines of log tail"
}

HTTP Methods

POST

Invokes a custom command on all of the specified service instances. Custom parameters are passed as a map using the POST method and contain the command name and parameter values for the specified command.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name true PathVariable
String serviceName The service name true PathVariable
String beanName deprecated true PathVariable
Map params The command parameters true RequestBody

Request

Request body for a POST on /service/applications/{applicationName}/services/{serviceName}/beans/{beanName}/invoke
{
  "param1 name" : "param1",
  "param2 name" : "param2"
}

Response

Response to a POST on /service/applications/{applicationName}/services/{serviceName}/beans/{beanName}/invoke
{
  "status" : "success",
  "response" : {
    "instance #1@127.0.0.1" : {
      "Invocation_Instance_Name" : "instance #1@127.0.0.1",
      "Invocation_Instance_ID" : "1",
      "Invocation_Result" : "the invocation result as specified in the service file",
      "Invocation_Success" : "true",
      "Invocation_Exception" : null,
      "Invocation_Command_Name" : "custom command name"
    }
  }
}

HTTP Methods

GET

Creates a list of all service instances in the specified application.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name true PathVariable
String serviceName The service name true PathVariable

Request

Request body for a GET on /service/applications/{applicationName}/services/{serviceName}/instances
request has no body

Response

Response to a GET on /service/applications/{applicationName}/services/{serviceName}/instances
{
  "status" : "success",
  "response" : {
    "1" : "127.0.0.1"
  }
}

$response.getComments()

HTTP Methods

POST

Invokes a custom command on a specific service instance. Custom parameters are passed as a map using POST method and contain the command name and parameter values for the specified command.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name true PathVariable
String serviceName The service name true PathVariable
int instanceId The service instance number to be invoked true PathVariable
String beanName depreciated true PathVariable
Map params a Map containing the result of each invocation on a service instance true RequestBody

Request

Request body for a POST on /service/applications/{applicationName}/services/{serviceName}/instances/{instanceId}/beans/{beanName}/invoke
{
  "param1 name" : "param1",
  "param2 name" : "param2"
}

Response

Response to a POST on /service/applications/{applicationName}/services/{serviceName}/instances/{instanceId}/beans/{beanName}/invoke
{
  "status" : "success",
  "response" : {
    "Invocation_Instance_Name" : "instance #1@127.0.0.1",
    "Invocation_Instance_ID" : "1",
    "Invocation_Result" : "the invocation result as specified in the service file",
    "Invocation_Success" : "true",
    "Invocation_Exception" : null,
    "Invocation_Command_Name" : "custom command name"
  }
}

HTTP Methods

DELETE

Decrements the service instance number of the specified service.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name where the service resides true PathVariable
String serviceName The service name true PathVariable
int instanceId the service instance ID to remove true PathVariable

Request

Request body for a DELETE on /service/applications/{applicationName}/services/{serviceName}/instances/{instanceId}/remove
request has no body

Response

Response to a DELETE on /service/applications/{applicationName}/services/{serviceName}/instances/{instanceId}/remove
{"status": "success"}

HTTP Methods

GET

Retrieves the tail of a service log. This method used the service name and instance id To retrieve the the instance log tail.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name true PathVariable
String serviceName The service name true PathVariable
int instanceId The service instance id true PathVariable
int numLines The number of lines to tail true RequestParam

Request

Request body for a GET on /service/applications/{applicationName}/services/{serviceName}/instances/{instanceId}/tail
{
  "numLines" : 10
}

Response

Response to a GET on /service/applications/{applicationName}/services/{serviceName}/instances/{instanceId}/tail
{
  "status" : "success",
  "response" : "log tail from container"
}

HTTP Methods

GET

Retrieves the log tail from all of the specified service's instances. To retrieve the the instance log tail.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name true PathVariable
String serviceName The service name true PathVariable
int numLines The number of lines to tail true RequestParam

Request

Request body for a GET on /service/applications/{applicationName}/services/{serviceName}/tail
{
  "numLines" : 10
}

Response

Response to a GET on /service/applications/{applicationName}/services/{serviceName}/tail
{
  "status" : "success",
  "response" : "instance log tail"
}

HTTP Methods

DELETE

undeploys the specified service of the specific application.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name true PathVariable
String serviceName The service name true PathVariable
int timeoutInMinutes true PathVariable

Request

Request body for a DELETE on /service/applications/{applicationName}/services/{serviceName}/timeout/{timeoutInMinutes}/undeploy
request has no body

Response

Response to a DELETE on /service/applications/{applicationName}/services/{serviceName}/timeout/{timeoutInMinutes}/undeploy
{
  "status" : "success",
  "response" : {
    "lifecycleEventContainerID" : "bfae0a89-b5a0-4250-b393-6cedbf63ac76"
  }
}

HTTP Methods

POST

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName true PathVariable
String serviceName true PathVariable
int timeout true PathVariable
String template false RequestParam
String zone true RequestParam
MultipartFile file true RequestParam
MultipartFile props true RequestParam
String authGroups The authorization groups for which this deployment will be available false RequestParam
MultipartFile serviceOverridesFile A file containing overrides for service's properties file false RequestParam
MultipartFile cloudOverridesFile A file containing override parameters to be used by the cloud driver false RequestParam
Boolean selfHealing false RequestParam true

Request

Request body for a POST on /service/applications/{applicationName}/services/{serviceName}/timeout/{timeout}
{
  "zone" : 5,
  "template" : "SMALL_LINUX",
  "file" : "packaged service file",
  "props" : "packaged properties file"
}

Response

Response to a POST on /service/applications/{applicationName}/services/{serviceName}/timeout/{timeout}
{
  "status" : "success",
  "response" : "b41febb7-f48e-48d4-b14a-a6000d402d93"
}

HTTP Methods

POST

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName true PathVariable
String serviceName true PathVariable
int timeout true PathVariable
int count true RequestParam
boolean location-aware true RequestParam

Request

Request body for a POST on /service/applications/{applicationName}/services/{serviceName}/timeout/{timeout}/set-instances
{
  "count" : 1,
  "location-aware" : true
}

Response

Response to a POST on /service/applications/{applicationName}/services/{serviceName}/timeout/{timeout}/set-instances
{
  "status" : "success",
  "response" : {
    "lifecycleEventContainerID" : "eventContainerID"
  }
}

HTTP Methods

DELETE

Uninstalls an application by uninstalling all of its services. Order of uninstallations is determined by the context property 'com.gs.application.services' which should exist in all service PUs.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name true PathVariable
int timeoutInMinutes true PathVariable

Request

Request body for a DELETE on /service/applications/{applicationName}/timeout/{timeoutInMinutes}
request has no body

Response

Response to a DELETE on /service/applications/{applicationName}/timeout/{timeoutInMinutes}
{
  "status" : "success",
  "response" : {
    "lifecycleEventContainerID" : "bfae0a89-b5a0-4250-b393-6cedbf63ac76"
  }
}

HTTP Methods

POST

Deploys an application to the service grid. An application is consisted of a group of services that might have dependencies between themselves. The application will be deployed according to the dependency order defined in the application file and deployed asynchronously if possible.

Parameters

Type Name Description Mandatory Parameter type Default value
String applicationName The application name true PathVariable
int timeout true PathVariable
MultipartFile file The compressed application file true RequestParam
String authGroups The authorization groups for which this deployment will be available false RequestParam
MultipartFile recipeOverridesFile The application overrides file - to overrides the application properties false RequestParam
MultipartFile cloudOverridesFile File of overriding cloud properties false RequestParam
Boolean selfHealing if true, there will be an attempt to restart the recipe in case a problem occurred in its life-cycle, otherwise, if the recipe fails to execute, no attempt to recover will made false RequestParam
boolean debugAll Indicates if all lifecycle events should have a breakpoint false RequestParam false
String debugEvents Indicates which lifecycle events should have a breakpoint false RequestParam
String debugMode Indicates the debug mode to use One of 'instead', 'after' or 'onError' false RequestParam

Request

Request body for a POST on /service/applications/{applicationName}/timeout/{timeout}
{
  "applicationName" : "petclinic",
  "srcFile" : "packaged application file",
  "recipeOverridesFile" : "recipe overrides file"
}

Response

Response to a POST on /service/applications/{applicationName}/timeout/{timeout}
{
  "status" : "success",
  "response" : {
    "serviceOrder" : "[mongod,mongoConfig,apacheLB,mongos,tomcat]",
    "lifecycleEventContainerID" : "07db2a16-62f8-4669-ac41-ed9afe3a3b02"
  }
}

HTTP Methods

GET

Request

Request body for a GET on /service/controllers
request has no body

Response

Response to a GET on /service/controllers
{
  "status" : "Success",
  "message" : "Operation completed successfully",
  "messageId" : "operation_successfull",
  "verbose" : null,
  "response" : [ ]
}

DELETE

Schedules termination of all agents running the cloudify manager.

Request

Request body for a DELETE on /service/controllers
request has no body

Response

Response to a DELETE on /service/controllers
{
  "status" : "Success",
  "message" : "Operation completed successfully",
  "messageId" : "operation_successfull",
  "verbose" : null,
  "response" : [ ]
}

HTTP Methods

GET

Get the dump of a given machine, by its ip.

Parameters

Type Name Description Mandatory Parameter type Default value
String ip true PathVariable
String processors The list of processors to be used false RequestParam summary, network, thread, log
long fileSizeLimit false RequestParam 10485760

Request

Request body for a GET on /service/dump/machine/{ip}
{
  "fileSizeLimit" : 50000000,
  "processors" : "summary, network, log"
}

Response

Response to a GET on /service/dump/machine/{ip}
{
  "status" : "success",
  "response" : {
    "<machine's ip>" : "<byte array of the dump file>"
  }
}

HTTP Methods

GET

Get the dump of all the machines.

Parameters

Type Name Description Mandatory Parameter type Default value
String processors The list of processors to be used false RequestParam summary, network, thread, log
long fileSizeLimit false RequestParam 10485760

Request

Request body for a GET on /service/dump/machines
{
  "fileSizeLimit" : 50000000,
  "processors" : "summary, thread, log"
}

Response

Response to a GET on /service/dump/machines
{
  "status" : "success",
  "response" : {
    "192.168.2.100" : "<byte array of the dump file>",
    "192.168.2.200" : "<byte array of the dump file>",
    "192.168.2.300" : "<byte array of the dump file>"
  }
}

HTTP Methods

GET

Get the dump of all the services.

Parameters

Type Name Description Mandatory Parameter type Default value
long fileSizeLimit false RequestParam 10485760

Request

Request body for a GET on /service/dump/processing-units
{
  "fileSizeLimit" : 50000000
}

Response

Response to a GET on /service/dump/processing-units
{
  "status" : "success",
  "response" : "<byte array of the dump file>"
}

HTTP Methods

GET

Returns the lifecycle events according to the lifecycleEventContainerID id that is returned as a response when installing/un-installing a service/application and according to the cursor position.

Parameters

Type Name Description Mandatory Parameter type Default value
String lifecycleEventContainerID the unique task ID true PathVariable
int cursor event entry cursor true PathVariable

Request

Request body for a GET on /service/lifecycleEventContainerID/{lifecycleEventContainerID}/cursor/{cursor}
request has no body

Response

Response to a GET on /service/lifecycleEventContainerID/{lifecycleEventContainerID}/cursor/{cursor}
{
  "status" : "success",
  "response" : {
    "isDone" : false,
    "lifecycleLogs" : [ "[service1] Deployed 1 planned 1", "Service \"service1\" successfully installed (1 Instances)" ],
    "PollingTaskExpirationTimeMillis" : "575218",
    "curserPos" : 12
  }
}

HTTP Methods

POST

Add templates to the cloud.

Parameters

Type Name Description Mandatory Parameter type Default value
MultipartFile templatesFolder The templates zip file true RequestParam

Request

Request body for a POST on /service/templates
{
  "templatesFolder" : "templates folder"
}

Response

Response to a POST on /service/templates
{
  "status" : "success",
  "response" : [ "template1", "template2", "template3" ]
}

$response.getComments()

GET

Get the cloud's templates.

Request

Request body for a GET on /service/templates
request has no body

Response

Response to a GET on /service/templates
{
  "status" : "success",
  "response" : {
    "SMALL_LINUX" : {
      "imageId" : "us-east-1/ami-1624987f",
      "hardwareId" : "m1.small",
      "locationId" : "us-east-1",
      "localDirectory" : "upload",
      "keyFile" : "user-ec2-east.pem",
      "numberOfCores" : 1,
      "options" : {
        "securityGroups" : [ "default" ],
        "keyPair" : "user-ec2-east"
      },
      "overrides" : { },
      "fileTransfer" : "SCP",
      "remoteExecution" : "SSH",
      "username" : "ec2-user",
      "remoteDirectory" : "/home/ec2-user/gs-files",
      "privileged" : true,
      "absoluteUploadDir" : "/home/ec2-user/gs-files/upload",
      "machineMemoryMB" : 1600
    }
  }
}

HTTP Methods

GET

Get template from the cloud.

Parameters

Type Name Description Mandatory Parameter type Default value
String templateName The name of the template to get true PathVariable

Request

Request body for a GET on /service/templates/{templateName}
request has no body

Response

Response to a GET on /service/templates/{templateName}
{
  "status" : "success",
  "response" : {
    "imageId" : "us-east-1/ami-1624987f",
    "hardwareId" : "m1.small",
    "locationId" : "us-east-1",
    "localDirectory" : "upload",
    "keyFile" : "user-ec2-east.pem",
    "numberOfCores" : 1,
    "options" : {
      "securityGroups" : [ "default" ],
      "keyPair" : "user-ec2-east"
    },
    "overrides" : { },
    "fileTransfer" : "SCP",
    "remoteExecution" : "SSH",
    "username" : "ec2-user",
    "remoteDirectory" : "/home/ec2-user/gs-files",
    "privileged" : true,
    "absoluteUploadDir" : "/home/ec2-user/gs-files/upload",
    "machineMemoryMB" : 1600
  }
}

DELETE

Removes a template from the cloud.

Parameters

Type Name Description Mandatory Parameter type Default value
String templateName The name of the template to remove true PathVariable

Request

Request body for a DELETE on /service/templates/{templateName}
request has no body

Response

Response to a DELETE on /service/templates/{templateName}
{"status": "success"}

$response.getComments()

HTTP Methods

GET

Tests whether the authentication was successful.

Request

Request body for a GET on /service/testlogin
request has no body

Response

Response to a GET on /service/testlogin
{
  "status" : "error",
  "response" : {
    "error" : "Login failed",
    "error_args" : [ [ "localcloud" ], [ "jini://127.0.0.1:4172/" ] ]
  }
}

$response.getComments()

HTTP Methods

GET

Tests whether the restful service is able to locate the service grid using the admin API.

The admin API searches for a LUS (Lookup Service) according to the lookup groups/locators defined.

Request

Request body for a GET on /service/testrest
request has no body

Response

Response to a GET on /service/testrest
{
  "status" : "error",
  "response" : {
    "error" : "failed_to_locate_lookup_service",
    "error_args" : [ [ "localcloud" ], [ "jini://127.0.0.1:4172/" ] ]
  }
}

$response.getComments()

HTTP Methods

GET

Verifies the authenticated user has role ROLE_CLOUDADMIINS.

Request

Request body for a GET on /service/verifyCloudAdmin
request has no body

Response

Response to a GET on /service/verifyCloudAdmin
{
  "status" : "error",
  "response" : {
    "error" : "User is not a CloudAdmin",
    "error_args" : [ [ "localcloud" ], [ "jini://127.0.0.1:4172/" ] ]
  }
}

$response.getComments()

RepoController

Mapping of URIs that begin with /{version}/repo

RepoController provides Rest implementation for The Recipes stored for users to use.

HTTP Methods

POST

push application recipe .

Request

Request body for a POST on /{version}/repo/apps
request has no body

Response

Response to a POST on /{version}/repo/apps
response has no body

HTTP Methods

GET

get application recipe given name.

Parameters

Type Name Description Mandatory Parameter type Default value
String appName the application name true PathVariable

Request

Request body for a GET on /{version}/repo/apps/{appName}
request has no body

Response

Response to a GET on /{version}/repo/apps/{appName}
response has no body

PUT

update application recipe given name.

Parameters

Type Name Description Mandatory Parameter type Default value
String appName the application name true PathVariable

Request

Request body for a PUT on /{version}/repo/apps/{appName}
request has no body

Response

Response to a PUT on /{version}/repo/apps/{appName}
response has no body

DELETE

delete application recipe given name.

Parameters

Type Name Description Mandatory Parameter type Default value
String appName the application name true PathVariable

Request

Request body for a DELETE on /{version}/repo/apps/{appName}
request has no body

Response

Response to a DELETE on /{version}/repo/apps/{appName}
response has no body

ManagementController

Mapping of URIs that begin with /{version}/management

This controller is responsible for retrieving information about management machines. It is also the entry point for shutdown managers.

The response body will always return in a JSON representation of the {@link org.cloudifysource.dsl.rest.response.Response} Object.
A controller method may return the {@link org.cloudifysource.dsl.rest.response.Response} Object directly. in this case this return value will be used as the response body. Otherwise, an implicit wrapping will occur. the return value will be inserted into {@code Response#setResponse(Object)}. other fields of the {@link org.cloudifysource.dsl.rest.response.Response} object will be filled with default values.

Important

{@code @ResponseBody} annotations are not permitted.

Possible return values

200 - OK
400 - controller throws an exception
500 - Unexpected exception

HTTP Methods

DELETE

Schedules termination of all agents running the cloudify manager.

Request

Request body for a DELETE on /{version}/management/controllers
request has no body

Response

Response to a DELETE on /{version}/management/controllers
{
  "status" : "Success",
  "message" : "Operation completed successfully",
  "messageId" : "operation_successfull",
  "verbose" : null,
  "response" : {
    "controllers" : null
  }
}

GET

Request

Request body for a GET on /{version}/management/controllers
request has no body

Response

Response to a GET on /{version}/management/controllers
response has no body

HTTP Methods

GET

Get the dump of a given machine, by its IP.

Parameters

Type Name Description Mandatory Parameter type Default value
String ip The machine IP true PathVariable
String processors The list of processors to be used false RequestParam summary,network,thread,log
long fileSizeLimit The dump file size limit false RequestParam 10485760

Request

Request body for a GET on /{version}/management/dump/machine/{ip}
request has no body

Response

Response to a GET on /{version}/management/dump/machine/{ip}
{
  "status" : "Success",
  "message" : "Operation completed successfully",
  "messageId" : "operation_successfull",
  "verbose" : null,
  "response" : {
    "dumpBytes" : null
  }
}

HTTP Methods

GET

Get the dump of all machines.

Parameters

Type Name Description Mandatory Parameter type Default value
String processors The list of processors to be used false RequestParam summary,network,thread,log
long fileSizeLimit The dump file size limit false RequestParam 10485760

Request

Request body for a GET on /{version}/management/dump/machines
request has no body

Response

Response to a GET on /{version}/management/dump/machines
{
  "status" : "Success",
  "message" : "Operation completed successfully",
  "messageId" : "operation_successfull",
  "verbose" : null,
  "response" : {
    "dumpBytesPerIP" : null
  }
}

HTTP Methods

GET

Parameters

Type Name Description Mandatory Parameter type Default value
long fileSizeLimit the file size limit false RequestParam 10485760

Request

Request body for a GET on /{version}/management/dump/processing-units
request has no body

Response

Response to a GET on /{version}/management/dump/processing-units
{
  "status" : "Success",
  "message" : "Operation completed successfully",
  "messageId" : "operation_successfull",
  "verbose" : null,
  "response" : {
    "dumpData" : null
  }
}

InfraController

Mapping of URIs that begin with /{version}/infra

InfraController provides Rest implementation for Infra.

  • Hosts – the actually managed hosts
  • Storage – the actual handlers for Storage
  • Load Balancer – the handler for LB and its groups
  • HTTP Methods

    GET

    get all hosts.

    Request

    Request body for a GET on /{version}/infra/hosts
    request has no body

    Response

    Response to a GET on /{version}/infra/hosts
    response has no body

    PUT

    add BYON host.

    Request

    Request body for a PUT on /{version}/infra/hosts
    request has no body

    Response

    Response to a PUT on /{version}/infra/hosts
    response has no body

    DELETE

    remove BYON host.

    Request

    Request body for a DELETE on /{version}/infra/hosts
    request has no body

    Response

    Response to a DELETE on /{version}/infra/hosts
    response has no body

    HTTP Methods

    POST

    add group security.

    Request

    Request body for a POST on /{version}/infra/securitygroups
    request has no body

    Response

    Response to a POST on /{version}/infra/securitygroups
    response has no body

    HTTP Methods

    POST

    add security rule.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String groupName the group name true PathVariable

    Request

    Request body for a POST on /{version}/infra/securitygroups/{groupName}
    request has no body

    Response

    Response to a POST on /{version}/infra/securitygroups/{groupName}
    response has no body

    DELETE

    remove security rule.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String groupName the group name true PathVariable

    Request

    Request body for a DELETE on /{version}/infra/securitygroups/{groupName}
    request has no body

    Response

    Response to a DELETE on /{version}/infra/securitygroups/{groupName}
    response has no body

    PUT

    update security rule.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String groupName the group name true PathVariable

    Request

    Request body for a PUT on /{version}/infra/securitygroups/{groupName}
    request has no body

    Response

    Response to a PUT on /{version}/infra/securitygroups/{groupName}
    response has no body

    GET

    get security rule by name.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String groupName the group name true PathVariable

    Request

    Request body for a GET on /{version}/infra/securitygroups/{groupName}
    request has no body

    Response

    Response to a GET on /{version}/infra/securitygroups/{groupName}
    response has no body

    DeploymentsController

    Mapping of URIs that begin with /{version}/deployments

    This controller is responsible for retrieving information about deployments. It is also the entry point for deploying services and application.

    The response body will always return in a JSON representation of the {@link org.cloudifysource.dsl.rest.response.Response} Object.
    A controller method may return the {@link org.cloudifysource.dsl.rest.response.Response} Object directly. in this case this return value will be used as the response body. Otherwise, an implicit wrapping will occur. the return value will be inserted into {@code Response#setResponse(Object)}. other fields of the {@link org.cloudifysource.dsl.rest.response.Response} object will be filled with default values.

    Important

    {@code @ResponseBody} annotations are not permitted.

    Possible return values

    200 - OK
    400 - controller throws an exception
    500 - Unexpected exception

    HTTP Methods

    GET

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String serviceName true PathVariable

    Request

    Request body for a GET on /{version}/deployments/appName}/service/{serviceName}/alerts
    request has no body

    Response

    Response to a GET on /{version}/deployments/appName}/service/{serviceName}/alerts
    response has no body

    HTTP Methods

    GET

    Request

    Request body for a GET on /{version}/deployments/applications/description
    request has no body

    Response

    Response to a GET on /{version}/deployments/applications/description
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : [ {
        "servicesDescription" : [ {
          "serviceName" : "service0",
          "instanceCount" : 4,
          "plannedInstances" : 4,
          "instancesDescription" : [ {
            "instanceName" : "petclinic.service0",
            "instanceStatus" : "RUNNING",
            "instanceId" : 0,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          }, {
            "instanceName" : "petclinic.service0",
            "instanceStatus" : "RUNNING",
            "instanceId" : 2,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          } ],
          "applicationName" : "petclinic",
          "serviceState" : "STARTED",
          "deploymentId" : null
        }, {
          "serviceName" : "service1",
          "instanceCount" : 2,
          "plannedInstances" : 2,
          "instancesDescription" : [ {
            "instanceName" : "petclinic.service1",
            "instanceStatus" : "RUNNING",
            "instanceId" : 1,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          }, {
            "instanceName" : "petclinic.service1",
            "instanceStatus" : "RUNNING",
            "instanceId" : 3,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          } ],
          "applicationName" : "petclinic",
          "serviceState" : "STARTED",
          "deploymentId" : null
        } ],
        "applicationName" : "petclinic",
        "authGroups" : "myAuthGroup1,myAuthGroup2,myAuthGroup3",
        "applicationState" : "STARTED"
      }, {
        "servicesDescription" : [ {
          "serviceName" : "service2",
          "instanceCount" : 2,
          "plannedInstances" : 2,
          "instancesDescription" : [ {
            "instanceName" : "petclinic.service2",
            "instanceStatus" : "RUNNING",
            "instanceId" : 2,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          }, {
            "instanceName" : "petclinic.service2",
            "instanceStatus" : "RUNNING",
            "instanceId" : 4,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          } ],
          "applicationName" : "petclinic",
          "serviceState" : "STARTED",
          "deploymentId" : null
        }, {
          "serviceName" : "service3",
          "instanceCount" : 5,
          "plannedInstances" : 5,
          "instancesDescription" : [ {
            "instanceName" : "petclinic.service3",
            "instanceStatus" : "RUNNING",
            "instanceId" : 3,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          }, {
            "instanceName" : "petclinic.service3",
            "instanceStatus" : "RUNNING",
            "instanceId" : 5,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          } ],
          "applicationName" : "petclinic",
          "serviceState" : "STARTED",
          "deploymentId" : null
        } ],
        "applicationName" : "petclinic",
        "authGroups" : "myAuthGroup1,myAuthGroup2,myAuthGroup3",
        "applicationState" : "STARTED"
      }, {
        "servicesDescription" : [ {
          "serviceName" : "service4",
          "instanceCount" : 3,
          "plannedInstances" : 3,
          "instancesDescription" : [ {
            "instanceName" : "petclinic.service4",
            "instanceStatus" : "RUNNING",
            "instanceId" : 4,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          }, {
            "instanceName" : "petclinic.service4",
            "instanceStatus" : "RUNNING",
            "instanceId" : 6,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          } ],
          "applicationName" : "petclinic",
          "serviceState" : "STARTED",
          "deploymentId" : null
        }, {
          "serviceName" : "service5",
          "instanceCount" : 1,
          "plannedInstances" : 1,
          "instancesDescription" : [ {
            "instanceName" : "petclinic.service5",
            "instanceStatus" : "RUNNING",
            "instanceId" : 5,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          }, {
            "instanceName" : "petclinic.service5",
            "instanceStatus" : "RUNNING",
            "instanceId" : 7,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          } ],
          "applicationName" : "petclinic",
          "serviceState" : "STARTED",
          "deploymentId" : null
        } ],
        "applicationName" : "petclinic",
        "authGroups" : "myAuthGroup1,myAuthGroup2,myAuthGroup3",
        "applicationState" : "STARTED"
      } ]
    }

    HTTP Methods

    GET

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable

    Request

    Request body for a GET on /{version}/deployments/applications/{appName}/description
    request has no body

    Response

    Response to a GET on /{version}/deployments/applications/{appName}/description
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "servicesDescription" : [ {
          "serviceName" : "service0",
          "instanceCount" : 1,
          "plannedInstances" : 1,
          "instancesDescription" : [ {
            "instanceName" : "petclinic.service0",
            "instanceStatus" : "RUNNING",
            "instanceId" : 0,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          }, {
            "instanceName" : "petclinic.service0",
            "instanceStatus" : "RUNNING",
            "instanceId" : 2,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          } ],
          "applicationName" : "petclinic",
          "serviceState" : "STARTED",
          "deploymentId" : null
        }, {
          "serviceName" : "service1",
          "instanceCount" : 5,
          "plannedInstances" : 5,
          "instancesDescription" : [ {
            "instanceName" : "petclinic.service1",
            "instanceStatus" : "RUNNING",
            "instanceId" : 1,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          }, {
            "instanceName" : "petclinic.service1",
            "instanceStatus" : "RUNNING",
            "instanceId" : 3,
            "hostName" : "build64A",
            "hostAddress" : "192.168.9.18"
          } ],
          "applicationName" : "petclinic",
          "serviceState" : "STARTED",
          "deploymentId" : null
        } ],
        "applicationName" : "petclinic",
        "authGroups" : "myAuthGroup1,myAuthGroup2,myAuthGroup3",
        "applicationState" : "STARTED"
      }
    }

    HTTP Methods

    POST

    Invokes a custom command on a specific service instance. Custom parameters are passed as a map using POST method and contain the command name and parameter values for the specified command.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    int instanceId The service instance number to be invoked true PathVariable
    InvokeCustomCommandRequest request InvokeCustomCommandRequest the request containing the relevant parameters true RequestBody

    Request

    Request body for a POST on /{version}/deployments/applications/{applicationName}/services/{serviceName}/instances/{instanceId}/invoke
    {
      "commandName" : null,
      "parameters" : null
    }

    Response

    Response to a POST on /{version}/deployments/applications/{applicationName}/services/{serviceName}/instances/{instanceId}/invoke
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "invocationResult" : null
      }
    }

    HTTP Methods

    POST

    Invokes a custom command on all of the specified service instances. Custom parameters are passed as a map using the POST method and contain the command name and parameter values for the specified command.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    InvokeCustomCommandRequest request InvokeCustomCommandRequest the request containing the relevant parameters true RequestBody

    Request

    Request body for a POST on /{version}/deployments/applications/{applicationName}/services/{serviceName}/invoke
    {
      "commandName" : null,
      "parameters" : null
    }

    Response

    Response to a POST on /{version}/deployments/applications/{applicationName}/services/{serviceName}/invoke
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "invocationResultPerInstance" : { }
      }
    }

    HTTP Methods

    GET

    Basic test to see if the rest is connected properly.

    Request

    Request body for a GET on /{version}/deployments/testrest
    request has no body

    Response

    Response to a GET on /{version}/deployments/testrest
    response has no body

    HTTP Methods

    POST

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    InstallApplicationRequest request install application request true RequestBody

    Request

    Request body for a POST on /{version}/deployments/{appName}
    {
      "applcationFileUploadKey" : "84eddf57-6282-4806-a2e1-002fedc36e2a",
      "applicationOverridesUploadKey" : "de810fa7-c28b-408b-9fbd-6cfc8b309d25",
      "cloudOverridesUploadKey" : "0ed0e547-879f-4e76-b3b3-21148ed9638b",
      "applicationName" : "petclinic",
      "authGroups" : "myAuthGroup",
      "debugMode" : "onError",
      "debugEvents" : "init,install",
      "cloudConfigurationUploadKey" : "e30ccfa8-ad2b-468d-bdda-826d7ba55b3a",
      "debugAll" : false,
      "selfHealing" : true
    }

    Response

    Response to a POST on /{version}/deployments/{appName}
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "deploymentID" : "62cd7e92-45d9-45d8-ab64-62382197e6a7"
      }
    }

    DELETE

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    Integer timeoutInMinutes The timeout in minutes false RequestParam 15

    Request

    Request body for a DELETE on /{version}/deployments/{appName}
    request has no body

    Response

    Response to a DELETE on /{version}/deployments/{appName}
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "deploymentID" : "f1c364db-e15d-4ff1-b756-4d8597e99766"
      }
    }

    GET

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}
    response has no body

    PUT

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable

    Request

    Request body for a PUT on /{version}/deployments/{appName}
    request has no body

    Response

    Response to a PUT on /{version}/deployments/{appName}
    response has no body

    HTTP Methods

    POST

    Sets application level attributes for the given application.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    SetApplicationAttributesRequest attributesRequest Request body, specifying the attributes names and values true RequestBody

    Request

    Request body for a POST on /{version}/deployments/{appName}/attributes
    {
      "attributes" : {
        "attr2" : "value2",
        "attr1" : "value1",
        "attr3" : "value3"
      }
    }

    Response

    Response to a POST on /{version}/deployments/{appName}/attributes
    response has no body

    GET

    Retrieves application level attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}/attributes
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}/attributes
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "attributes" : {
          "attr2" : "value2",
          "attr1" : "value1",
          "attr3" : "value3"
        }
      }
    }

    HTTP Methods

    PUT

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String attributeName true PathVariable
    UpdateApplicationAttributeRequest updateApplicationAttributeRequest true RequestBody

    Request

    Request body for a PUT on /{version}/deployments/{appName}/attributes/{attributeName}
    {
      "value" : "attributeValue"
    }

    Response

    Response to a PUT on /{version}/deployments/{appName}/attributes/{attributeName}
    response has no body

    DELETE

    Deletes an application level attribute.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String attributeName The attribute name true PathVariable

    Request

    Request body for a DELETE on /{version}/deployments/{appName}/attributes/{attributeName}
    request has no body

    Response

    Response to a DELETE on /{version}/deployments/{appName}/attributes/{attributeName}
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "previousValue" : "attributeValue"
      }
    }

    HTTP Methods

    GET

    Retrieves service level attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}/service/{serviceName}/attributes
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}/service/{serviceName}/attributes
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "attributes" : {
          "attr2" : "value2",
          "attr1" : "value1",
          "attr3" : "value3"
        }
      }
    }

    POST

    Sets service level attributes for the given application.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable
    SetServiceAttributesRequest request Request body, specifying the attributes names and values true RequestBody

    Request

    Request body for a POST on /{version}/deployments/{appName}/service/{serviceName}/attributes
    {
      "attributes" : {
        "attr2" : "value2",
        "attr1" : "value1",
        "attr3" : "value3"
      }
    }

    Response

    Response to a POST on /{version}/deployments/{appName}/service/{serviceName}/attributes
    response has no body

    PUT

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String serviceName true PathVariable

    Request

    Request body for a PUT on /{version}/deployments/{appName}/service/{serviceName}/attributes
    request has no body

    Response

    Response to a PUT on /{version}/deployments/{appName}/service/{serviceName}/attributes
    response has no body

    HTTP Methods

    DELETE

    Deletes a service level attribute.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable
    String attributeName The attribute name true PathVariable

    Request

    Request body for a DELETE on /{version}/deployments/{appName}/service/{serviceName}/attributes/{attributeName}
    request has no body

    Response

    Response to a DELETE on /{version}/deployments/{appName}/service/{serviceName}/attributes/{attributeName}
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "previousValue" : "attributeValue"
      }
    }

    HTTP Methods

    GET

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String serviceName true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}/service/{serviceName}/description
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}/service/{serviceName}/description
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : [ {
        "serviceName" : "service2",
        "instanceCount" : 3,
        "plannedInstances" : 3,
        "instancesDescription" : [ {
          "instanceName" : "petclinic.service2",
          "instanceStatus" : "RUNNING",
          "instanceId" : 2,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        }, {
          "instanceName" : "petclinic.service2",
          "instanceStatus" : "RUNNING",
          "instanceId" : 4,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        } ],
        "applicationName" : "petclinic",
        "serviceState" : "STARTED",
        "deploymentId" : null
      }, {
        "serviceName" : "service3",
        "instanceCount" : 1,
        "plannedInstances" : 1,
        "instancesDescription" : [ {
          "instanceName" : "petclinic.service3",
          "instanceStatus" : "RUNNING",
          "instanceId" : 3,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        }, {
          "instanceName" : "petclinic.service3",
          "instanceStatus" : "RUNNING",
          "instanceId" : 5,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        } ],
        "applicationName" : "petclinic",
        "serviceState" : "STARTED",
        "deploymentId" : null
      } ]
    }

    HTTP Methods

    GET

    Retrieves service instance level attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable
    Integer instanceId The instance id true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/attributes
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/attributes
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "attributes" : {
          "attr2" : "value2",
          "attr1" : "value1",
          "attr3" : "value3"
        }
      }
    }

    POST

    Sets service instance level attributes for the given application.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable
    Integer instanceId The instance id true PathVariable
    SetServiceInstanceAttributesRequest request Request body, specifying the attributes names and values true RequestBody

    Request

    Request body for a POST on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/attributes
    {
      "attributes" : {
        "attr2" : "value2",
        "attr1" : "value1",
        "attr3" : "value3"
      }
    }

    Response

    Response to a POST on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/attributes
    response has no body

    PUT

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String serviceName true PathVariable
    String instanceId true PathVariable

    Request

    Request body for a PUT on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/attributes
    request has no body

    Response

    Response to a PUT on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/attributes
    response has no body

    HTTP Methods

    DELETE

    Delete an instance level attribute.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable
    Integer instanceId The instance id true PathVariable
    String attributeName The attribute name true PathVariable

    Request

    Request body for a DELETE on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/attributes/{attributeName}
    request has no body

    Response

    Response to a DELETE on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/attributes/{attributeName}
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "previousValue" : "attributeValue"
      }
    }

    HTTP Methods

    GET

    Provides various meta data about the service instance.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable
    Integer instanceId The instance id true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/metadata
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/metadata
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "instanceId" : 1,
        "applicationName" : "petclinic",
        "serviceName" : "tomcat",
        "serviceInstanceName" : "petclinic.tomcat",
        "privateIp" : "192.168.9.18",
        "publicIp" : "192.168.9.18",
        "templateName" : "SMALL_UBUNTU",
        "imageId" : "localcloud",
        "hardwareId" : "localcloud",
        "machineId" : "localcloud",
        "processDetails" : {
          "Cloud Public IP" : "192.168.9.18",
          "icon" : "icon.png",
          "Cloud Image ID" : "localcloud",
          "Cloud Private IP" : "192.168.9.18",
          "GSC PID" : "4276",
          "Cloud Hardware ID" : "localcloud",
          "Instance ID" : 1,
          "Machine ID" : "localcloud",
          "Working Directory" : "D:\\gigaSpaces\\gigaspaces-cloudify\\work\\processing-units\\simpleApp_simple_1_1051025036\\ext",
          "url" : null
        }
      }
    }

    POST

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String serviceName true PathVariable
    String instanceId true PathVariable

    Request

    Request body for a POST on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/metadata
    request has no body

    Response

    Response to a POST on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/metadata
    response has no body

    HTTP Methods

    GET

    Retrieves USM metric details about the service instance.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable
    Integer instanceId The instance id true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/metrics
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}/service/{serviceName}/instances/{instanceId}/metrics
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "serviceName" : "tomcat",
        "appName" : "petclinic",
        "serviceInstanceMetricsData" : {
          "instanceId" : 3,
          "metrics" : {
            "metric3" : "value3",
            "metric4" : "value4"
          }
        }
      }
    }

    HTTP Methods

    GET

    Provides various meta data about the service.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}/service/{serviceName}/metadata
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}/service/{serviceName}/metadata
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "name" : "tomcat",
        "applicationName" : "petclinic",
        "numberOfInstances" : 2,
        "instanceNames" : [ "petclinic.tomcat", "petclinic.tomcat", "petclinic.tomcat" ]
      }
    }

    POST

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String serviceName true PathVariable

    Request

    Request body for a POST on /{version}/deployments/{appName}/service/{serviceName}/metadata
    request has no body

    Response

    Response to a POST on /{version}/deployments/{appName}/service/{serviceName}/metadata
    response has no body

    PUT

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String serviceName true PathVariable

    Request

    Request body for a PUT on /{version}/deployments/{appName}/service/{serviceName}/metadata
    request has no body

    Response

    Response to a PUT on /{version}/deployments/{appName}/service/{serviceName}/metadata
    response has no body

    HTTP Methods

    GET

    Retrieves USM metric details about the service.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name true PathVariable
    String serviceName The service name true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}/service/{serviceName}/metrics
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}/service/{serviceName}/metrics
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "serviceName" : "tomcat",
        "appName" : "petclinic",
        "serviceInstaceMetricsData" : [ {
          "instanceId" : 2,
          "metrics" : {
            "metric2" : "value2",
            "metric3" : "value3"
          }
        }, {
          "instanceId" : 1,
          "metrics" : {
            "metric2" : "value2",
            "metric1" : "value1"
          }
        } ]
      }
    }

    HTTP Methods

    POST

    Executes an install service request onto the grid. This method is not synchronous, it does not wait for the installation to complete.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName The application name this service belongs to true PathVariable
    String serviceName The service name true PathVariable
    InstallServiceRequest request Request body, specifying all the needed parameters for the service true RequestBody

    Request

    Request body for a POST on /{version}/deployments/{appName}/services/{serviceName}
    {
      "serviceFolderUploadKey" : "cd0e776c-ec1e-4850-9489-d57a7198b000",
      "cloudConfigurationUploadKey" : "ca26cc4d-f7c1-4143-a7d8-c74ef51e4024",
      "cloudOverridesUploadKey" : "6506c7db-757f-4219-8661-cac09d1867ed",
      "serviceOverridesUploadKey" : "e975ec1b-30c0-4cab-aa4e-7e5ac22f1713",
      "serviceFileName" : "myService.groovy",
      "authGroups" : "myAuthGroup",
      "selfHealing" : true,
      "debugAll" : false,
      "debugEvents" : "init,install",
      "debugMode" : "onError"
    }

    Response

    Response to a POST on /{version}/deployments/{appName}/services/{serviceName}
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "deploymentID" : "c4b06f8a-b5cb-4b5d-9d97-16ec486ab5f8"
      }
    }

    DELETE

    Uninstalls a service.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName the application name true PathVariable
    String serviceName the service name true PathVariable
    Integer timeoutInMinutes timeout in minutes false RequestParam 5

    Request

    Request body for a DELETE on /{version}/deployments/{appName}/services/{serviceName}
    request has no body

    Response

    Response to a DELETE on /{version}/deployments/{appName}/services/{serviceName}
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "deploymentID" : "ae62a0c9-70cd-4125-bc2d-feb6c99725d7"
      }
    }

    GET

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String serviceName true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{appName}/services/{serviceName}
    request has no body

    Response

    Response to a GET on /{version}/deployments/{appName}/services/{serviceName}
    response has no body

    PUT

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String appName true PathVariable
    String serviceName true PathVariable

    Request

    Request body for a PUT on /{version}/deployments/{appName}/services/{serviceName}
    request has no body

    Response

    Response to a PUT on /{version}/deployments/{appName}/services/{serviceName}
    response has no body

    HTTP Methods

    POST

    Sets the number of instances of a service to a given value. This operation is only allowed for services that are marked as Elastic (defined in the recipe). Note: set instances does NOT support multi-tenancy. You should only use set-instances with dedicated machine SLA. Manually scaling a multi-tenant service will cause unexpected side-effect.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName the application name true PathVariable
    String serviceName the service name true PathVariable
    SetServiceInstancesRequest request the request details true RequestBody

    Request

    Request body for a POST on /{version}/deployments/{applicationName}/services/{serviceName}/count
    {
      "timeout" : 5,
      "count" : 2,
      "locationAware" : false
    }

    Response

    Response to a POST on /{version}/deployments/{applicationName}/services/{serviceName}/count
    response has no body

    HTTP Methods

    GET

    Retrieves a list of service descriptions belonging to a specific deployment.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String deploymentId The deployment id true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{deploymentId}/description
    request has no body

    Response

    Response to a GET on /{version}/deployments/{deploymentId}/description
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : [ [ {
        "serviceName" : "service1",
        "instanceCount" : 3,
        "plannedInstances" : 3,
        "instancesDescription" : [ {
          "instanceName" : "petclinic.service1",
          "instanceStatus" : "RUNNING",
          "instanceId" : 1,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        }, {
          "instanceName" : "petclinic.service1",
          "instanceStatus" : "RUNNING",
          "instanceId" : 3,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        } ],
        "applicationName" : "petclinic",
        "serviceState" : "STARTED",
        "deploymentId" : null
      }, {
        "serviceName" : "service2",
        "instanceCount" : 4,
        "plannedInstances" : 4,
        "instancesDescription" : [ {
          "instanceName" : "petclinic.service2",
          "instanceStatus" : "RUNNING",
          "instanceId" : 2,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        }, {
          "instanceName" : "petclinic.service2",
          "instanceStatus" : "RUNNING",
          "instanceId" : 4,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        } ],
        "applicationName" : "petclinic",
        "serviceState" : "STARTED",
        "deploymentId" : null
      } ], [ {
        "serviceName" : "service3",
        "instanceCount" : 3,
        "plannedInstances" : 3,
        "instancesDescription" : [ {
          "instanceName" : "petclinic.service3",
          "instanceStatus" : "RUNNING",
          "instanceId" : 3,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        }, {
          "instanceName" : "petclinic.service3",
          "instanceStatus" : "RUNNING",
          "instanceId" : 5,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        } ],
        "applicationName" : "petclinic",
        "serviceState" : "STARTED",
        "deploymentId" : null
      }, {
        "serviceName" : "service4",
        "instanceCount" : 5,
        "plannedInstances" : 5,
        "instancesDescription" : [ {
          "instanceName" : "petclinic.service4",
          "instanceStatus" : "RUNNING",
          "instanceId" : 4,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        }, {
          "instanceName" : "petclinic.service4",
          "instanceStatus" : "RUNNING",
          "instanceId" : 6,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        } ],
        "applicationName" : "petclinic",
        "serviceState" : "STARTED",
        "deploymentId" : null
      } ], [ {
        "serviceName" : "service2",
        "instanceCount" : 1,
        "plannedInstances" : 1,
        "instancesDescription" : [ {
          "instanceName" : "petclinic.service2",
          "instanceStatus" : "RUNNING",
          "instanceId" : 2,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        }, {
          "instanceName" : "petclinic.service2",
          "instanceStatus" : "RUNNING",
          "instanceId" : 4,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        } ],
        "applicationName" : "petclinic",
        "serviceState" : "STARTED",
        "deploymentId" : null
      }, {
        "serviceName" : "service3",
        "instanceCount" : 2,
        "plannedInstances" : 2,
        "instancesDescription" : [ {
          "instanceName" : "petclinic.service3",
          "instanceStatus" : "RUNNING",
          "instanceId" : 3,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        }, {
          "instanceName" : "petclinic.service3",
          "instanceStatus" : "RUNNING",
          "instanceId" : 5,
          "hostName" : "build64A",
          "hostAddress" : "192.168.9.18"
        } ],
        "applicationName" : "petclinic",
        "serviceState" : "STARTED",
        "deploymentId" : null
      } ] ]
    }

    HTTP Methods

    GET

    Retrieves events based on deployment id. The deployment id may be of service or application. In the case of an application deployment id, all services events will be returned.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String deploymentId The deployment id given at install time true PathVariable
    int from The starting index false RequestParam 1
    int to The finish index false RequestParam -1

    Request

    Request body for a GET on /{version}/deployments/{deploymentId}/events
    request has no body

    Response

    Response to a GET on /{version}/deployments/{deploymentId}/events
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "events" : [ {
          "description" : "[127.0.0.1/127.0.0.1] - tomcat-1 INIT invoked",
          "index" : 0
        }, {
          "description" : "[127.0.0.1/127.0.0.1] - tomcat-1 INIT completed, duration: 4.2 seconds",
          "index" : 1
        } ]
      }
    }

    HTTP Methods

    GET

    Returns the last event for a specific operation.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String deploymentId the operation ID true PathVariable

    Request

    Request body for a GET on /{version}/deployments/{deploymentId}/events/last
    request has no body

    Response

    Response to a GET on /{version}/deployments/{deploymentId}/events/last
    {
      "status" : "Success",
      "message" : "Operation completed successfully",
      "messageId" : "operation_successfull",
      "verbose" : null,
      "response" : {
        "description" : null,
        "index" : 0
      }
    }

    ConfigController

    Mapping of URIs that begin with /{version}/config

    ConfigRestController provides Rest implementation for Configuration.

    HTTP Methods

    POST

    add compute template.

    Request

    Request body for a POST on /{version}/config/compute
    request has no body

    Response

    Response to a POST on /{version}/config/compute
    response has no body

    GET

    get all compute template.

    Request

    Request body for a GET on /{version}/config/compute
    request has no body

    Response

    Response to a GET on /{version}/config/compute
    response has no body

    DELETE

    delete compute template.

    Request

    Request body for a DELETE on /{version}/config/compute
    request has no body

    Response

    Response to a DELETE on /{version}/config/compute
    response has no body

    HTTP Methods

    POST

    add load balancer template.

    Request

    Request body for a POST on /{version}/config/loadbalancer
    request has no body

    Response

    Response to a POST on /{version}/config/loadbalancer
    response has no body

    GET

    get all load balancer templates.

    Request

    Request body for a GET on /{version}/config/loadbalancer
    request has no body

    Response

    Response to a GET on /{version}/config/loadbalancer
    response has no body

    DELETE

    delete load balancer templates.

    Request

    Request body for a DELETE on /{version}/config/loadbalancer
    request has no body

    Response

    Response to a DELETE on /{version}/config/loadbalancer
    response has no body

    HTTP Methods

    POST

    add network template.

    Request

    Request body for a POST on /{version}/config/network
    request has no body

    Response

    Response to a POST on /{version}/config/network
    response has no body

    HTTP Methods

    GET

    get all network template.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String networkName the network name true PathVariable

    Request

    Request body for a GET on /{version}/config/network/{networkName}
    request has no body

    Response

    Response to a GET on /{version}/config/network/{networkName}
    response has no body

    DELETE

    delete network template.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String networkName the network name true PathVariable

    Request

    Request body for a DELETE on /{version}/config/network/{networkName}
    request has no body

    Response

    Response to a DELETE on /{version}/config/network/{networkName}
    response has no body

    HTTP Methods

    POST

    add security group template.

    Request

    Request body for a POST on /{version}/config/securitygroups
    request has no body

    Response

    Response to a POST on /{version}/config/securitygroups
    response has no body

    HTTP Methods

    POST

    add storage templates.

    Request

    Request body for a POST on /{version}/config/storage
    request has no body

    Response

    Response to a POST on /{version}/config/storage
    response has no body

    GET

    get all storage templates.

    Request

    Request body for a GET on /{version}/config/storage
    request has no body

    Response

    Response to a GET on /{version}/config/storage
    response has no body

    DELETE

    delete storage templates.

    Request

    Request body for a DELETE on /{version}/config/storage
    request has no body

    Response

    Response to a DELETE on /{version}/config/storage
    response has no body

    AttributesController

    Mapping of URIs that begin with /attributes

    HTTP Methods

    GET

    Gets multiple attributes' values, scope: application attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable

    Request

    Request body for a GET on /attributes/applications/{applicationName}
    request has no body

    Response

    Response to a GET on /attributes/applications/{applicationName}
    {
      "status" : "success",
      "response" : {
        "attribute1Name" : "attribute1Value",
        "attribute2Name" : "attribute2Value"
      }
    }

    POST

    Sets multiple attributes' values, scope: application attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    Map attributesMap a Map containing the attributes' names (keys) and values to set true RequestBody

    Request

    Request body for a POST on /attributes/applications/{applicationName}
    {
      "attribute1Name" : "attribute1Value",
      "attribute2Name" : "attribute2Value"
    }

    Response

    Response to a POST on /attributes/applications/{applicationName}
    {"status": "success"}

    DELETE

    Deletes multiple attributes, scope: application attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable

    Request

    Request body for a DELETE on /attributes/applications/{applicationName}
    request has no body

    Response

    Response to a DELETE on /attributes/applications/{applicationName}
    {
      "status" : "success",
      "response" : {
        "attribute1Name" : "attribute1Value",
        "attribute2Name" : "attribute2Value"
      }
    }

    $response.getComments()

    HTTP Methods

    GET

    Gets an attribute value, scope: application attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String attributeName The name (key) of the attribute to get true PathVariable

    Request

    Request body for a GET on /attributes/applications/{applicationName}/{attributeName}
    request has no body

    Response

    Response to a GET on /attributes/applications/{applicationName}/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    POST

    Sets an attribute value, scope: application attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String attributeName The name of the attribute to get true PathVariable
    Object attributeValue The value to set true RequestBody

    Request

    Request body for a POST on /attributes/applications/{applicationName}/{attributeName}
    "attributeValue"

    Response

    Response to a POST on /attributes/applications/{applicationName}/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    $response.getComments()

    DELETE

    Deletes an attribute value, scope: application attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String attributeName The name of the attribute to get true PathVariable

    Request

    Request body for a DELETE on /attributes/applications/{applicationName}/{attributeName}
    request has no body

    Response

    Response to a DELETE on /attributes/applications/{applicationName}/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    $response.getComments()

    HTTP Methods

    GET

    Gets multiple attributes' values, scope: global attributes.

    Request

    Request body for a GET on /attributes/globals
    request has no body

    Response

    Response to a GET on /attributes/globals
    {
      "status" : "success",
      "response" : {
        "attribute1Name" : "attribute1Value",
        "attribute2Name" : "attribute2Value"
      }
    }

    POST

    Sets multiple attributes' values, scope: global attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    Map attributesMap a Map containing the attributes' names (keys) and values to set true RequestBody

    Request

    Request body for a POST on /attributes/globals
    {
      "attribute1Name" : "attribute1Value",
      "attribute2Name" : "attribute2Value"
    }

    Response

    Response to a POST on /attributes/globals
    {"status": "success"}

    DELETE

    Deletes multiple attributes, scope: global attributes.

    Request

    Request body for a DELETE on /attributes/globals
    request has no body

    Response

    Response to a DELETE on /attributes/globals
    {
      "status" : "success",
      "response" : {
        "attribute1Name" : "attribute1Value",
        "attribute2Name" : "attribute2Value"
      }
    }

    $response.getComments()

    HTTP Methods

    GET

    Gets an attribute value, scope: global attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String attributeName The name (key) of the attribute to get true PathVariable

    Request

    Request body for a GET on /attributes/globals/{attributeName}
    request has no body

    Response

    Response to a GET on /attributes/globals/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    POST

    Sets an attribute value, scope: global attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String attributeName The name of the attribute to get true PathVariable
    Object attributeValue The value to set true RequestBody

    Request

    Request body for a POST on /attributes/globals/{attributeName}
    "attributeValue"

    Response

    Response to a POST on /attributes/globals/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    $response.getComments()

    DELETE

    Deletes an attribute, scope: global attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String attributeName The name of the attribute to delete true PathVariable

    Request

    Request body for a DELETE on /attributes/globals/{attributeName}
    request has no body

    Response

    Response to a DELETE on /attributes/globals/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    $response.getComments()

    HTTP Methods

    GET

    Gets multiple attributes' values, from all instances, scope: instance attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable

    Request

    Request body for a GET on /attributes/instances/{applicationName}/{serviceName}
    request has no body

    Response

    Response to a GET on /attributes/instances/{applicationName}/{serviceName}
    {
      "status" : "success",
      "response" : {
        "instanceId:attribute1Name" : "attribute1Value",
        "instanceId:attribute2Name" : "attribute2Value"
      }
    }

    HTTP Methods

    GET

    Gets multiple attributes' values, scope: instance attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    int instanceId The service instance id true PathVariable

    Request

    Request body for a GET on /attributes/instances/{applicationName}/{serviceName}/{instanceId}
    request has no body

    Response

    Response to a GET on /attributes/instances/{applicationName}/{serviceName}/{instanceId}
    {
      "status" : "success",
      "response" : {
        "attribute1Name" : "attribute1Value",
        "attribute2Name" : "attribute2Value"
      }
    }

    POST

    Sets multiple attributes' values, scope: instance attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    int instanceId The service instance id true PathVariable
    Map attributesMap a Map containing the attributes' names (keys) and values to set true RequestBody

    Request

    Request body for a POST on /attributes/instances/{applicationName}/{serviceName}/{instanceId}
    {
      "attribute1Name" : "attribute1Value",
      "attribute2Name" : "attribute2Value"
    }

    Response

    Response to a POST on /attributes/instances/{applicationName}/{serviceName}/{instanceId}
    {"status": "success"}

    DELETE

    Deletes multiple attributes, scope: instance attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    int instanceId The service instance id true PathVariable

    Request

    Request body for a DELETE on /attributes/instances/{applicationName}/{serviceName}/{instanceId}
    request has no body

    Response

    Response to a DELETE on /attributes/instances/{applicationName}/{serviceName}/{instanceId}
    {
      "status" : "success",
      "response" : {
        "attribute1Name" : "attribute1Value",
        "attribute2Name" : "attribute2Value"
      }
    }

    $response.getComments()

    HTTP Methods

    GET

    Gets an attribute value, scope: instance attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    int instanceId The service instance id true PathVariable
    String attributeName The name (key) of the attribute to get true PathVariable

    Request

    Request body for a GET on /attributes/instances/{applicationName}/{serviceName}/{instanceId}/{attributeName}
    request has no body

    Response

    Response to a GET on /attributes/instances/{applicationName}/{serviceName}/{instanceId}/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    POST

    Sets an attribute value, scope: instance attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    int instanceId The service instance id true PathVariable
    String attributeName The name of the attribute to get true PathVariable
    Object attributeValue The value to set true RequestBody

    Request

    Request body for a POST on /attributes/instances/{applicationName}/{serviceName}/{instanceId}/{attributeName}
    "attributeValue"

    Response

    Response to a POST on /attributes/instances/{applicationName}/{serviceName}/{instanceId}/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    $response.getComments()

    DELETE

    Deletes an attribute value, scope: instance attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    int instanceId The service instance id true PathVariable
    String attributeName The name of the attribute to get true PathVariable

    Request

    Request body for a DELETE on /attributes/instances/{applicationName}/{serviceName}/{instanceId}/{attributeName}
    request has no body

    Response

    Response to a DELETE on /attributes/instances/{applicationName}/{serviceName}/{instanceId}/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    $response.getComments()

    HTTP Methods

    GET

    Gets multiple attributes' values, scope: service attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable

    Request

    Request body for a GET on /attributes/services/{applicationName}/{serviceName}
    request has no body

    Response

    Response to a GET on /attributes/services/{applicationName}/{serviceName}
    {
      "status" : "success",
      "response" : {
        "attribute1Name" : "attribute1Value",
        "attribute2Name" : "attribute2Value"
      }
    }

    POST

    Sets multiple attributes' values, scope: service attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    Map attributesMap a Map containing the attributes' names (keys) and values to set true RequestBody

    Request

    Request body for a POST on /attributes/services/{applicationName}/{serviceName}
    {
      "attribute1Name" : "attribute1Value",
      "attribute2Name" : "attribute2Value"
    }

    Response

    Response to a POST on /attributes/services/{applicationName}/{serviceName}
    {"status": "success"}

    DELETE

    Deletes multiple attributes, scope: service attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable

    Request

    Request body for a DELETE on /attributes/services/{applicationName}/{serviceName}
    request has no body

    Response

    Response to a DELETE on /attributes/services/{applicationName}/{serviceName}
    {
      "status" : "success",
      "response" : {
        "attribute1Name" : "attribute1Value",
        "attribute2Name" : "attribute2Value"
      }
    }

    $response.getComments()

    HTTP Methods

    GET

    Gets an attribute value, scope: service attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    String attributeName The name (key) of the attribute to get true PathVariable

    Request

    Request body for a GET on /attributes/services/{applicationName}/{serviceName}/{attributeName}
    request has no body

    Response

    Response to a GET on /attributes/services/{applicationName}/{serviceName}/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    POST

    Sets an attribute value, scope: service attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    String attributeName The name of the attribute to get true PathVariable
    Object attributeValue The value to set true RequestBody

    Request

    Request body for a POST on /attributes/services/{applicationName}/{serviceName}/{attributeName}
    "attributeValue"

    Response

    Response to a POST on /attributes/services/{applicationName}/{serviceName}/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    $response.getComments()

    DELETE

    Deletes an attribute value, scope: service attributes.

    Parameters

    Type Name Description Mandatory Parameter type Default value
    String applicationName The application name true PathVariable
    String serviceName The service name true PathVariable
    String attributeName The name of the attribute to get true PathVariable

    Request

    Request body for a DELETE on /attributes/services/{applicationName}/{serviceName}/{attributeName}
    request has no body

    Response

    Response to a DELETE on /attributes/services/{applicationName}/{serviceName}/{attributeName}
    {
      "status" : "success",
      "response" : {
        "attributeName" : "attributeValue"
      }
    }

    $response.getComments()

    AlertController

    Mapping of URIs that begin with /{version}/alerts

    AlertsRestController provides Rest implementation for Alerts.

    HTTP Methods

    GET

    get manager alerts.

    Request

    Request body for a GET on /{version}/alerts/
    request has no body

    Response

    Response to a GET on /{version}/alerts/
    response has no body