Management API Reference for deployment

Children (2)

• subdeployment
• subsystem
  • batch-jberet
  • datasources
  • ejb3
  • jaxrs
  • jpa
  • logging
  • messaging-activemq
  • microprofile-opentracing-smallrye
  • resource-adapters
  • undertow
  • webservices

Attributes (12)

• content - List of pieces of content that comprise the deployment.

  Type	LIST
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of pieces of content that comprise the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 1, "stability" : "default", "value-type" : { "hash" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "path", "relative-to" ], "min-length" : 20, "max-length" : 20, "stability" : "default" }, "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Path (relative or absolute) to unmanaged content that is part of the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["hash"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "relative-to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of a system path to which the value of the 'path' is relative. If not set, the 'path' is considered to be absolute.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["hash"], "requires" : ["path"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "archive" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag indicating whether unmanaged content is a zip archive (true) or exploded (false).", "expressions-allowed" : false, "required" : false, "nillable" : true, "requires" : [ "path", "hash" ], "stability" : "default" } }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

• disabled-time - Last time the application was disabled

  Type	LONG
  Unit	MILLISECONDS
  Is the attribute nillable?	true
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Last time the application was disabled", "expressions-allowed" : false, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• disabled-timestamp - Last timestamp the application was disabled. Format is yyyy-MM-dd HH:mm:ss,SSS zzz.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Last timestamp the application was disabled. Format is yyyy-MM-dd HH:mm:ss,SSS zzz.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• enabled - Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

• enabled-time - Last time the application was enabled

  Type	LONG
  Unit	MILLISECONDS
  Is the attribute nillable?	true
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Last time the application was enabled", "expressions-allowed" : false, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• enabled-timestamp - Last timestamp the application was enabled. Format is yyyy-MM-dd HH:mm:ss,SSS zzz.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Last timestamp the application was enabled. Format is yyyy-MM-dd HH:mm:ss,SSS zzz.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• managed - Indicates if the deployment is managed (aka uses the ContentRepository).

  Type	BOOLEAN
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates if the deployment is managed (aka uses the ContentRepository).", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• name - Unique identifier of the deployment. Must be unique across all deployments.

  Type	STRING
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Unique identifier of the deployment. Must be unique across all deployments.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

• owner - Address of a resource that has indicated it controls the lifecycle of this deployment (e.g. a deployment scanner resource.) Will be undefined if no resource claimed ownership when the deployment was added.

  Type	OBJECT
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Address of a resource that has indicated it controls the lifecycle of this deployment (e.g. a deployment scanner resource.) Will be undefined if no resource claimed ownership when the deployment was added.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

• persistent - Boolean indicating whether the existence of the deployment should be recorded in the persistent server configuration. Only relevant to a standalone mode server. Default is 'true'. A deployment managed by a deployment scanner would have this set to 'false' to ensure the deployment is only deployed at server start if the scanner again detects the deployment.

  Type	BOOLEAN
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Boolean indicating whether the existence of the deployment should be recorded in the persistent server configuration. Only relevant to a standalone mode server. Default is 'true'. A deployment managed by a deployment scanner would have this set to 'false' to ensure the deployment is only deployed at server start if the scanner again detects the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

• runtime-name - Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of "foo.war") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.

  Type	STRING
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of \"foo.war\") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

• status - The current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was not enabled or was manually stopped.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	runtime
  Access Type	metric
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was not enabled or was manually stopped.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (11)

• add - Adds previously uploaded content to the list of content available for use. Does not actually deploy the content unless the 'enabled' parameter is 'true'.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  runtime-name	STRING	false	false		Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of "foo.war") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.
  content	LIST	true	false		List of pieces of content that comprise the deployment.
  enabled	BOOLEAN	false	false	false	Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)

  Raw DMR model

  { "operation-name" : "add", "description" : "Adds previously uploaded content to the list of content available for use. Does not actually deploy the content unless the 'enabled' parameter is 'true'.", "request-properties" : { "runtime-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of \"foo.war\") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "content" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of pieces of content that comprise the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 1, "stability" : "default", "value-type" : { "input-stream-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The index into the operation's attached input streams of the input stream that contains deployment content that should be uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "hash", "bytes", "url", "path", "relative-to", "empty" ], "min" : 1, "max" : 2147483647, "filesystem-path" : true, "attached-streams" : true, "stability" : "default" }, "hash" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "input-stream-index", "bytes", "url", "path", "relative-to", "empty" ], "min-length" : 20, "max-length" : 20, "stability" : "default" }, "bytes" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "Byte array containing the deployment content that should uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "url", "path", "relative-to", "empty" ], "stability" : "default" }, "url" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The URL at which the deployment content is available for upload to the domain's or standalone server's deployment content repository.. Note that the URL must be accessible from the target of the operation (i.e. the Domain Controller or standalone server).", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes", "path", "relative-to", "empty" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Path (relative or absolute) to unmanaged content that is part of the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes", "url", "empty" ], "requires" : ["archive"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "relative-to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of a system path to which the value of the 'path' is relative. If not set, the 'path' is considered to be absolute.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes", "url", "empty" ], "requires" : ["path"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "archive" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag indicating whether unmanaged content is a zip archive (true) or exploded (false).", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "bytes", "url" ], "requires" : [ "path", "hash", "empty" ], "stability" : "default" }, "empty" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates that the deployment to be added is empty - so without any content.", "expressions-allowed" : false, "required" : true, "nillable" : true, "default" : false, "alternatives" : [ "hash", "input-stream-index", "bytes", "url", "path", "relative-to" ], "stability" : "default" } } }, "enabled" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• add-content - Add contents to an existing deployment.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  content	LIST	true	false		List of pieces of content to be added to the deployment.
  overwrite	BOOLEAN	false	false	true	Indicates if added content should overwrite existing content.

  Raw DMR model

  { "operation-name" : "add-content", "description" : "Add contents to an existing deployment.", "request-properties" : { "content" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of pieces of content to be added to the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "input-stream-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The index into the operation's attached input streams of the input stream that contains deployment content that should be uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "hash", "bytes", "url" ], "min" : 1, "max" : 2147483647, "filesystem-path" : true, "attached-streams" : true, "stability" : "default" }, "hash" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "bytes", "url" ], "min-length" : 20, "max-length" : 20, "stability" : "default" }, "bytes" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "Byte array containing the deployment content that should uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "url" ], "stability" : "default" }, "url" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The URL at which the deployment content is available for upload to the domain's or standalone server's deployment content repository.. Note that the URL must be accessible from the target of the operation (i.e. the Domain Controller or standalone server).", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "target-path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The relative path of an exploded deployment of this content.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "relative-to" : true, "stability" : "default" } } }, "overwrite" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates if added content should overwrite existing content.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• browse-content - List the pieces of content of a deployment.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  path	STRING	false	false		The relative path from a deployment to list the contents of.
  archive	BOOLEAN	false	false	false	If set to true, only the relative paths to archive files will be returned.
  depth	INT	false	false	-1	The depth to browse.

  Reply properties

  The pieces of content of a deployment and some information about them.

  Type

  OBJECT

  Value Type

  
  {
      "directory" => {
          "type" => BOOLEAN,
          "description" => "Indicates if the content is a folder or not.",
          "expressions-allowed" => false,
          "required" => true,
          "nillable" => false,
          "stability" => "default"
      },
      "path" => {
          "type" => STRING,
          "description" => "Path (relative or absolute) to unmanaged content that is part of the deployment.",
          "expressions-allowed" => false,
          "required" => true,
          "nillable" => false,
          "min-length" => 1,
          "max-length" => 2147483647,
          "stability" => "default"
      },
      "file-size" => {
          "type" => LONG,
          "description" => "The size of the content if it is a file.",
          "expressions-allowed" => false,
          "required" => false,
          "nillable" => true,
          "unit" => "BYTES",
          "stability" => "default"
      }
  }

  Raw DMR model

  { "operation-name" : "browse-content", "description" : "List the pieces of content of a deployment.", "request-properties" : { "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The relative path from a deployment to list the contents of.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "relative-to" : true, "stability" : "default" }, "archive" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If set to true, only the relative paths to archive files will be returned.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "depth" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The depth to browse.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : -1, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The pieces of content of a deployment and some information about them.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "value-type" : { "directory" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates if the content is a folder or not.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }, "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Path (relative or absolute) to unmanaged content that is part of the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "file-size" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The size of the content if it is a file.", "expressions-allowed" : false, "required" : false, "nillable" : true, "unit" : "BYTES", "stability" : "default" } } }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• deploy - Deploy the specified deployment content into the runtime, optionally replacing existing content.

  Raw DMR model

  { "operation-name" : "deploy", "description" : "Deploy the specified deployment content into the runtime, optionally replacing existing content.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• explode - Convert zip format managed deployment content to exploded format.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  path	STRING	false	false		Relative path to an archive in a deployment to be exploded.

  Raw DMR model

  { "operation-name" : "explode", "description" : "Convert zip format managed deployment content to exploded format.", "request-properties" : {"path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Relative path to an archive in a deployment to be exploded.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "relative-to" : true, "stability" : "default" }}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• list-modules - List all module dependencies of the current deployment.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  verbose	BOOLEAN	false	false	false	Optional, default is false and results in brief info about the module dependencies, true to include detailed information about the module dependencies added to the current deployment.

  Raw DMR model

  { "operation-name" : "list-modules", "description" : "List all module dependencies of the current deployment.", "request-properties" : {"verbose" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Optional, default is false and results in brief info about the module dependencies, true to include detailed information about the module dependencies added to the current deployment.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }}, "reply-properties" : {}, "stability" : "default", "read-only" : true, "runtime-only" : false }

• read-content - Read the content of an existing deployment.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  path	STRING	false	false		The relative path of the content to be read from an existing deployment.

  Reply properties

  The uuid of the attached stream.

  Type

  STRING

  Raw DMR model

  { "operation-name" : "read-content", "description" : "Read the content of an existing deployment.", "request-properties" : {"path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The relative path of the content to be read from an existing deployment.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "relative-to" : true, "stability" : "default" }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The uuid of the attached stream.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• redeploy - Undeploy existing content from the runtime and deploy it again.

  Raw DMR model

  { "operation-name" : "redeploy", "description" : "Undeploy existing content from the runtime and deploy it again.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Remove a deployment from the list of content available for use. If the deployment is currently deployed in the runtime it will first be undeployed.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove a deployment from the list of content available for use. If the deployment is currently deployed in the runtime it will first be undeployed.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "all-services", "runtime-only" : false }

• remove-content - Remove contents from an existing deployment.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  paths	LIST	true	true		List of paths of content to be removed from the deployment.

  Raw DMR model

  { "operation-name" : "remove-content", "description" : "Remove contents from an existing deployment.", "request-properties" : {"paths" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of paths of content to be removed from the deployment.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "relative-to" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• undeploy - Undeploy content from the runtime. The content remains in the list of content available for use.

  Raw DMR model

  { "operation-name" : "undeploy", "description" : "Undeploy content from the runtime. The content remains in the list of content available for use.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• deployment

          
  <feature spec="deployment">
    <param name="deployment" value="{resource name}"/>
    <param name="content" value="{value}"/>
    <param name="enabled" value="{value}"/>
    <param name="runtime-name" value="{value}"/>
  <feature/>
          
        

  📋