Jump to

• Request
• Response
• Examples

Create A New Runtime

post

/management/lifecycle/{version}/runtimes

The POST method registers a runtime.

Roles

Admin

Request

Supported Media Types

• application/json

Path Parameters

• version: string
  The version of the WebLogic Lifecycle REST interface.

Body ()

The request body must include a fully populated runtime model.

Root Schema : Runtime

Type: object

Includes the name, type, host and port for a physical runtime. It can also include arbitrary properties.

Show Source

• hostName(optional): string
  The hostname of the runtime.
• name(optional): string
  The name of the runtime.
• port(optional): string
  The port of the runtime.
• properties(optional): array properties
  Arbitrary properties. These may include the username and password that are required to connect to the runtime.
• protocol(optional): string
  The protocol of the runtime.
• type(optional): string
  The type of the runtime.

{
    "description":"Includes the name, type, host and port for a physical runtime. It can also include arbitrary properties.",
    "properties":{
        "hostName":{
            "description":"The hostname of the runtime.",
            "type":"string"
        },
        "name":{
            "description":"The name of the runtime.",
            "type":"string"
        },
        "port":{
            "description":"The port of the runtime.",
            "type":"string"
        },
        "properties":{
            "description":"Arbitrary properties. These may include the username and password that are required\n to connect to the runtime.",
            "items":{
                "$ref":"#/definitions/Property"
            },
            "type":"array"
        },
        "protocol":{
            "description":"The protocol of the runtime.",
            "type":"string"
        },
        "type":{
            "description":"The type of the runtime.",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : properties

Type: array

Arbitrary properties. These may include the username and password that are required to connect to the runtime.

Show Source

• Array of: object Property
  Holds a named property, where the value can be a String, a confidential String, or a list of Properties.

{
    "description":"Arbitrary properties. These may include the username and password that are required\n to connect to the runtime.",
    "items":{
        "$ref":"#/definitions/Property"
    },
    "type":"array"
}

Nested Schema : Property

Type: object

Holds a named property, where the value can be a String, a confidential String, or a list of Properties.

Show Source

• confidentialValue(optional): string
  Property Confidential String value.
• properties(optional): array properties
  Property Properties value.
• values(optional): array values
  Property String values.

{
    "description":"Holds a named property, where the value can be a String, a confidential String, or a list of Properties.",
    "properties":{
        "confidentialValue":{
            "description":"Property Confidential String value.",
            "type":"string"
        },
        "properties":{
            "description":"Property Properties value.",
            "items":{
                "$ref":"#/definitions/Property"
            },
            "type":"array"
        },
        "values":{
            "description":"Property String values.",
            "items":{
                "$ref":"#/definitions/Property"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : properties

Type: array

Property Properties value.

Show Source

• Array of: object Property
  Holds a named property, where the value can be a String, a confidential String, or a list of Properties.

{
    "description":"Property Properties value.",
    "items":{
        "$ref":"#/definitions/Property"
    },
    "type":"array"
}

Nested Schema : values

Type: array

Property String values.

Show Source

• Array of: object Property
  Holds a named property, where the value can be a String, a confidential String, or a list of Properties.

{
    "description":"Property String values.",
    "items":{
        "$ref":"#/definitions/Property"
    },
    "type":"array"
}

Security

• Admin: basic
  Type: basic

Back to Top

Response

201 Response

Back to Top

Examples

Registering a Runtime

This example uses the POST method to register a runtime.

Example Request

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name": "WLSRuntime", "type": "wls",  "protocol": "http", "hostName": "localhost", "port": "7001", "properties": [{"name": "username", "value": "username"}, {"name": "password", "confidentialValue": "password"}]}'
-X POST http://localhost:7001/management/lifecycle/latest/runtimes

Example Response

HTTP/1.1 201 Created
Location: http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime
Response Body:
{}

Back to Top