RESTful Domain Runtime Management Interface for Oracle WebLogic Server

Deploy ( Name, Application Path, Targets, Plan, Deployment Options )

post

/management/weblogic/{version}/domainRuntime/deploymentManager/deploy

A convenience method for distributing and starting an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header.

Request

Supported Media Types

application/json

Path Parameters

version(required): string

The version of the WebLogic REST interface.

Header Parameters

Prefer: string

The 'Prefer' header parameter can be used to specify the preference on how this method runs. A value of 'respond-async' specifies a preference to submit the request and return immediately without waiting for completion. Alternatively a value of 'wait=#seconds' specifies a preference to wait for #seconds for method completion before returning. If the Prefer header is not specified or invalid, then a 300 second wait will be used.
X-Requested-By(required): string

The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

applicationPath: string

A supported Java EE application or module archive, or a root directory for the application or module.
deploymentOptions: object Properties

Title: Properties

Additional Properties Allowed: additionalProperties

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)
name: string

The name of the application
plan: string

The deployment plan for this application. May be null.
targets: array Items

Title: Items

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "applicationPath":{
            "type":"string",
            "description":"<p>A supported Java EE application or module archive, or a root directory for the application or module.</p>"
        },
        "deploymentOptions":{
            "type":"object",
            "description":"<p>Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "name":{
            "type":"string",
            "description":"<p>The name of the application</p>"
        },
        "plan":{
            "type":"string",
            "description":"<p>The deployment plan for this application.  May be null.</p>"
        },
        "targets":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.</p>"
        }
    },
    "description":""
}

Nested Schema : Properties

Type: object

Title: Properties

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"<p>Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Nested Schema : Items

Type: array

Title: Items

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Show Source

Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.</p>"
}

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.
Deployer: basic

Type: basic

Description: A user in the Deployer security role.

Response

Supported Media Types

application/json

200 Response

Returns the following fields:

Root Schema : Return

Type: object

Title: Return

Show Source

return: array Deployment Progress Object Reference

Title: Deployment Progress Object Reference

Contains the deployment progress object reference.
Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "title":"Deployment Progress Object Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the deployment progress object reference. <p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Nested Schema : Deployment Progress Object Reference

Type: array

Title: Deployment Progress Object Reference

Contains the deployment progress object reference.

Returns the action's result.

Show Source

Array of: string

{
    "title":"Deployment Progress Object Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the deployment progress object reference. <p>Returns the action's result.</p>"
}