RESTful Domain Runtime Management Interface for Oracle WebLogic Server

Shutdown Server

post

/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer

Shutdowns the named server.

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

ignoreSessions: boolean

Drop sessions immediately rather than waiting for them to complete or timeout.
serverName: string

Name of the server that needs to be shutdown
sessionTimeout: integer(int32)

shutdownTimeout Time limit (in seconds) for server to complete a graceful shutdown. The default is 0 indicating no timeout.
waitForAllSessions: boolean

Wait for all sessions (even sessions backed by a server) to complete.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "ignoreSessions":{
            "type":"boolean",
            "description":"<p>Drop sessions immediately rather than waiting for them to complete or timeout.</p>"
        },
        "serverName":{
            "type":"string",
            "description":"<p>Name of the server that needs to be shutdown</p>"
        },
        "sessionTimeout":{
            "type":"integer",
            "format":"int32",
            "description":"<p>shutdownTimeout Time limit (in seconds) for server to complete a graceful shutdown. The default is 0 indicating no timeout.</p>"
        },
        "waitForAllSessions":{
            "type":"boolean",
            "description":"<p>Wait for all sessions (even sessions backed by a server) to complete.</p>"
        }
    },
    "description":""
}

Security

Admin: basic

Type: basic

Description: A user in the Admin 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 Workflow Task Runtime Reference

Title: Workflow Task Runtime Reference

Contains the workflow task runtime reference.
Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "title":"Workflow Task Runtime Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the workflow task runtime reference. <p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Nested Schema : Workflow Task Runtime Reference

Type: array

Title: Workflow Task Runtime Reference

Contains the workflow task runtime reference.

Returns the action's result.

Show Source

Array of: string

{
    "title":"Workflow Task Runtime Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the workflow task runtime reference. <p>Returns the action's result.</p>"
}