This documentation describes the Oracle WebLogic Server RESTful life cycle management resources.
For a complete listing of the WLS REST reference documents and descriptions of their use, see Administering Oracle WebLogic Server with RESTful Management Services.
The versions resource contains information about the versions of the lifeycycle REST interface that are active and supported in the current the WLS domain.
The resource supports the following methods:
The GET method on this resource returns information about each supported version of this REST interface.
The response body returned includes a list of Version entities for the supported versions of this REST interface. The returned information includes which version is the latest and whether or not each version is active.
This method can return the following links:
uri=/lifecycle/12.2.1.0 rel=current
This example uses the GET method to list available versions.
Example Request
curl -v \ --user admin:admin123 \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/
Example Response
HTTP/1.1 200 OK
Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.0"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.0"
}
],
"version": "12.2.1.0",
"isLatest": true,
"lifecycle": "active"
}],
"links": [
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/"
},
{
"rel": "current",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.0"
}
]
}
The version resource contains information about the latest version of the lifeycycle REST interface that is supported by the WLS domain.
The resource supports the following methods:
The GET method on this resource returns information about the supported version of this REST interface.
The response body returned includes a Version entity that contains information about the latest supported REST lifecycle interface version that is active and supported in the current WLS release.
This method can return the following links:
uri=/lifecycle/{version}/environmentCreateForm rel=environmentCreateForm
uri=/lifecycle/{version}/environments rel=environments
uri=/lifecycle/{version}/plugins rel=plugins
uri=/lifecycle/{version}/runtimeCreateForm rel=runtimeCreateForm
uri=/lifecycle/{version}/runtimes rel=runtimes
uri=/lifecycle/{version}/tenantCreateForm rel=tenantCreateForm
uri=/lifecycle/{version}/tenants rel=tenants
This example uses the GET method to describe a version.
Example Request
curl -v \ --user admin:admin123 \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest
Example Response
HTTP/1.1 200 OK
Response Body:
{
"version": "12.2.1.0",
"isLatest": true,
"lifecycle": "active",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/"
},
{
"rel": "environmentCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environmentCreateForm"
},
{
"rel": "environments",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
},
{
"rel": "runtimeCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimeCreateForm"
},
{
"rel": "runtimes",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
},
{
"rel": "tenantCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenantCreateForm"
},
{
"rel": "tenants",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
},
{
"rel": "plugins",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins"
}
]
}
This resource describes the information that is needed to create the environment.
The resource supports the following methods:
The GET method on this resource returns an empty form for the Environment.
The response body returned includes an Environment entity that contains information about fields that need to be specified when creating the environment.
This method can return the following links:
uri=/environments rel=/environments
This example uses the GET method to get the environment create form.
Example Request
curl -v \ --user admin:admin123 \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/environmentCreateForm
Example Response
HTTP/1.1 200 OK
Response Body:
{
"name": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environmentCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environmentCreateForm"
},
{
"rel": "environments",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
}
]
}
This resource manages environments.
The resource supports the following methods:
The GET method on this resource returns a list of environments.
The response body returned includes a collection of Environment entities.
This example uses the GET method to display environments.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/environments
Example Response
HTTP/1.1 200 OK
Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
}
],
"name": "sprite"
}],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environmentCreateForm"
}
]
}
The POST method creates an environment.
This example uses the POST method to create an empty environment.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d "{ "name": "sprite" }" \
-X POST http://localhost:7001/management/lifecycle/latest/environments
Example Response
HTTP/1.1 201 Created
Location: http://localhost:7001/management/lifecycle/latest/environments/sprite
Response Body:
{}
This example uses the POST method to create an environment based on an orchestration so that partitions are created first and are then added to the environment.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name": "coke",
"orchestration": {"name": "orchestration1",
"args": [
{"name": "wls",
"properties": [
{"name": "partitionName", "value": "wlspartition1"},
{"name": "runtimeName", "value": "WLSTestRuntime"},
{"name": "partitionProperties",
"properties": [
{ "name" : "resourceGroups",
"properties" : [
{ "name" : "g1",
"properties" : [
{ "name" : "resourceGroupTemplate", "value" : "template1" },
{ "name" : "targets" , "value" : "VirtualHost-0"}]}]},
{"name" : "availableTargets" , "value" : "VirtualHost-0"}]
}]}]}}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments
Example Response
HTTP/1.1 201 Created
Location: http://localhost:7001/management/lifecycle/latest/environments/sprite
Response Body:
{}
This resource manages an environment.
The resource supports the following methods:
The DELETE method deletes the environment identified by the resource URL.
This example uses the DELETE method to delete a specific environment.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/environments/sprite
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns information about the environment identified by the resource URL.
The response body returned includes an Environment entity that contains information about the specified environment.
This example uses the GET method to display information about a specific environment.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/environments/sprite
Example Response
HTTP/1.1 200 OK
Response Body:
{
"name": "sprite",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "partitionCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/partitionCreateForm"
},
{
"rel": "partitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/partitions"
},
{
"rel": "associatePartitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/associatePartitions"
}
]
}
This resource is used to associate two environment partitions with each other.
The resource supports the following methods:
The POST method associates two environment partitions with each other.
This example uses the POST method to associate two partitions with each other.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{
"partition1Name": "SpritePartition",
"partition1RuntimeName": "WLSRuntime",
"partition2Name": "SpritePDB",
"partition2RuntimeName": "DBRuntime",
"properties":[
{"name": "jdbcSystemResource", "properties" : [
{"name": "resourceGroups", "properties": [
{"name": "g1", "value": "SpritePDB"}]}]},
{"name": "jdbcSystemResourceOverride", "value": "SpritePDB" }]}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/associatePartitions
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource cleans up and removes the environment which includes deprovisioning, disassociating, and removing partitions.
The resource supports the following methods:
The POST method deprovisions and disassociates partitions in the named environment. The named environment is then deleted.
This example uses the POST method to clean up the environment which includes deprovisioning the partition, deleting the partition, and deleting the environment.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d '{
"orchestration": {"name": "deleteAll",
"args": [
{"name": "wls",
"properties": [
{"name": "component", "properties": [
{"name": "componentName", "value": "MockComponent"},
{"name": "configurableAttributes", "properties": [
{"name": "name", "value": "MockComponent"},
{"name": "configurableAttributes", "properties": [
{"name": "mockUser", "value": "jennifer"}
]}
]}
]},
{"name": "partitionName", "value": "wlspartition1"}
]}
]}
}' -X POST http://localhost:7001/management/lifecycle/latest/environments/cokeenv/deprovision
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource allows you to dissociate associated partitions.
The resource supports the following methods:
The POST method dissociates two partitions.
This example uses the POST method to dissociate two partitions.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{
"partition1Name": "SpritePartition",
"partition1RuntimeName": "WLSRuntime",
"partition2Name": "SpritePDB",
"partition2RuntimeName": "DBRuntime",
"properties":[
{"name": "jdbcSystemResource", "properties" : [
{"name": "resourceGroups", "properties": [
{"name": "g1", "value": "SpritePDB"}]}]},
{"name": "jdbcSystemResourceOverride", "value": "SpritePDB" }]}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/dissociatePartitions
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource describes the information that is needed to add a partition to the environment.
The resource supports the following methods:
The GET method on this resource returns an empty form for the Partition.
The response body returned includes an EnvironmentPartition entity that contains information about fields that must be specified when adding a partition to the environment.
This method can return the following links:
uri=/partitions rel=/partitions
This example uses the GET method to get the partition create form.
Example Request
curl -v \ --user admin:admin123 \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/environments/sprite/partitionCreateForm
Example Response
HTTP/1.1 200 OK
Response Body:
{
"runtimeName": null,
"name": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitionCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitionCreateForm"
},
{
"rel": "partitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitions"
}
]
}
This resource manages environment partitions.
The resource supports the following methods:
The GET method on this resource returns a list of partitions for the environment identified by the resource URL.
The response body returned includes a collection of EnvironmentPartition entities.
This example uses the GET method to display the partitions for a specific environment.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/environments/sprite/partitions
Example Response
HTTP/1.1 200 OK
Response Body:
{
"items": [
{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
}
],
"runtimeName": "WLSRuntime",
"name": "SpritePartition"
}
],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitions"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitions"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitionCreateForm"
}
]
}
The POST method adds a partition to the environment identified by the resource URL.
This example uses the POST method to add a partition to an environment.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name": "SpritePartition", "runtimeName": "WLSRuntime"}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/partitions
Example Response
HTTP/1.1 201 Created
Location: http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition
Response Body:
{}
This resource manages the environment partition.
The resource supports the following methods:
The DELETE method deletes the partition identified by the resource URL.
This example uses the DELETE method to delete a specific partition.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns information about the partition identified by the resource URL.
The response body returned includes an EnvironmentPartition entity that contains information about the specified partition.
This example uses the GET method to display information about a specific partition.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition
Example Response
HTTP/1.1 200 OK
Response Body:
{
"runtimeName": "WLSRuntime",
"name": "SpritePartition",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitions"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
}
]
}
This resource migrates a partition.
The resource supports the following methods:
The POST method on this resource migrates the partition identified by the resource URL.
This example uses the POST method to migrate a specific partition.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{ "runtimeName": "WLSRuntime", "phase": "", "properties": [] }' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/partitions/SpritePartition
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource manages a partition task.
The resource supports the following methods:
The DELETE method cancels the task identified by the resource URL.
This example uses the DELETE method to cancel a specific task.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition/quiesce/task/quiescePartition/SpritePartition/_1_STOP
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns the status of the task identified by the resource URL.
The response body returned includes a Task entity that contains information about the specified task.
This example uses the GET method to display information about a specific task.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition/quiesce/task/quiescePartition/SpritePartition/_1_STOP
Example Response
HTTP/1.1 200 OK
Response Body:
{
"status": "TASK COMPLETED",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition\/quiesce\/task\/quiescePartition\/SpritePartition\/_1_STOP"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition\/quiesce\/task\/quiescePartition\/SpritePartition\/_1_STOP"
}
]
}
This resource quiesces a partition.
The resource supports the following methods:
The POST method performs a quiesce operation on the specified partition.
This example uses the POST method to quiesce a partition.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"phase": "", "properties" : []}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition/quiesce
Example Response
HTTP/1.1 202 Accepted
Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition\/quiesce\/task\/quiescePartition\/SpritePartition\/_1_STOP"
}]}
This resource is used to restart a partition.
The resource supports the following methods:
The POST method performs a restart operation on the specified partition.
This example uses the POST method to restart partition.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d '{"phase": "", "properties" : []}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/cokeenv/partitions/wlspartition1/restart
Example Response
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/cokeenv\/partitions\/wlspartition1\/restart\/task\/restartPartition\/wlspartition1\/_1_FORCE_RESTART"
}]}
This resource is used to start a partition. When you start a partition, all application deployments and resources become active and responsive to end users and other components.
The resource supports the following methods:
The POST method performs a start operation on the specified partition.
This example uses the POST method to start partition.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"phase": "", "properties" : []}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition/start
Example Response
HTTP/1.1 202 Accepted
Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition\/start\/task\/startPartition\/SpritePartition\/_2_START"
}]}
This resource synchronizes the environment.
The resource supports the following methods:
The POST method synchronizes the environment.
This example uses the POST method to synchronize the environment.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -d '' \ -X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/sync
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource manages plugins.
The resource supports the following methods:
The GET method on this resource returns a list of registered plugins.
The response body returned includes a collection of RegisterPlugin entities.
This example uses the GET method to display a list of registered plugins.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/plugins
Example Response
HTTP/1.1 200 OK
Response Body:
{
"items": [
{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
}
],
"name": "com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar",
"path": "\/opt\/wls\/src1214_build\/Oracle_Home\/wlserver\/modules\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
}
],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins"
}
]
}
The POST method registers a plugin.
This example uses the POST method to register a plugin.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{ "path": "/opt/wls/src1214_build/Oracle_Home/wlserver/modules/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar" }' \
-X POST http://localhost:7001/management/lifecycle/latest/plugins
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource manages a plugin.
The resource supports the following methods:
The DELETE method unregisters the plugin identified by the resource URL.
This example uses the DELETE method to unregister a specific plugin.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/plugins/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns information about the plugin identified by the resource URL.
The response body returned includes a RegisterPlugin entity that contains information about the specified plugin.
This example uses the GET method to display information about a specific plugin.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/plugins/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar
Example Response
HTTP/1.1 200 OK
Response Body:
{
"name": "com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar",
"path": "\/opt\/wls\/src1214_build\/Oracle_Home\/wlserver\/modules\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
}
]
}
This resource describes the information needed to register a runtime.
The resource supports the following methods:
The GET method on this resource returns an empty form for a runtime.
The response body returned includes a Runtime entity that contains information about fields which must be specified when registering a runtime.
This method can return the following links:
uri=/runtimes rel=/runtimes
This example uses the GET method to get the runtime create form.
Example Request
curl -v \ --user admin:admin123 \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimeCreateForm
Example Response
HTTP/1.1 200 OK
Response Body:
{
"name": null,
"properties": [],
"type": null,
"port": null,
"hostName": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimeCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimeCreateForm"
},
{
"rel": "runtimes",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
}
]
}
This resource manages runtimes.
The resource supports the following methods:
The GET method on this resource returns a list of runtimes.
The response body returned includes a collection of Runtime entities.
This example uses the GET method to display a list of runtimes.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimes
Example Response
HTTP/1.1 200 OK
Response Body:
{
"items": [
{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
}
],
"name": "WLSRuntime",
"properties": [
{
"name": "password",
"value": "password"
},
{
"name": "username",
"value": "username"
}
],
"type": "wls",
"protocol": "http",
"port": "7001",
"hostName": "localhost"
}
],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimeCreateForm"
}
]
}
The POST method registers 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:
{}
This resource manages a runtime.
The resource supports the following methods:
The DELETE method unregisters the runtime identified by the resource URL.
This example uses the DELETE method to unregister a specific runtime.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns information about the runtime identified by the resource URL.
The response body returned includes a Runtime entity that contains information about the specified runtime.
This example uses the GET method to display information about a specific runtime.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime
Example Response
HTTP/1.1 200 OK
Response Body:
{
"name": "WLSRuntime",
"properties": [
{
"name": "password",
"confidentialValue": "@_Oracle_Confidential_Property_Set_V1.1_#"
},
{
"name": "username",
"value": "username"
}
],
"type": "wls",
"protocol": "http",
"port": "7001",
"hostName": "localhost",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "partitionCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitionCreateForm"
},
{
"rel": "partitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
}
]
}
The POST method updates the runtime identified by the resource URL.
This example uses the POST method to update a specific runtime.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"hostName": "localhost", "port": "7001", "properties": [{"name": "username", "value": "username"}, {"name": "password", "value": "password"}]}'
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource describes the information needed to create a partition.
The resource supports the following methods:
The GET method on this resource returns an empty form for a partition.
The response body returned includes a RuntimePartition entity that contains information about fields which must be specified when creating partition.
This method can return the following links:
uri=/partitions rel=/partitions
This example uses the GET method to get the partition create form.
Example Request
curl -v \ --user admin:admin123 \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitionCreateForm
Example Response
HTTP/1.1 200 OK
Response Body:
{
"name": null,
"properties": [],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitionCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitionCreateForm"
},
{
"rel": "partitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
}
]
}
This resource manages runtime partitions.
The resource supports the following methods:
The DELETE method unregisters a partition identified by name.
This example uses the DELETE method to unregister partition.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitions?name=SpritePartition
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns a list of partitions for the runtime identified by the resource URL.
The response body returned includes a collection of RuntimePartition entities.
This example uses the GET method to display a list of partitions for a specific runtime.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSTestRuntime/partitions
Example Response
HTTP/1.1 200 OK
Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
}
],
"name": "SpritePartition",
"id": "429aaa5a-058d-452d-b256-ce874d6e8583"
}],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitionCreateForm"
}
]
}
The POST method creates or registers a partition in the runtime identified by the resource URL. If partition id is passed in model properties, the partition is registered. Otherwise it is created.
This example uses the POST method to create a partition in a runtime.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name":"SpritePartition",
"properties" : [
{ "name" : "resourceGroups",
"properties" : [
{ "name" : "g1",
"properties" : [
{ "name" : "useDefaultTarget", "value" : "false" },
{ "name" : "resourceGroupTemplate", "value" : "template1" },
{ "name" : "targets" , "values" : ["VirtualHost-0"]}]}]},
{"name" : "availableTargets" , "values" : ["VirtualHost-0"]}]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitions
Example Response
HTTP/1.1 201 Created
Location: http://localhost:7001/management/lifecycle/latest/runtimes/WLSTestRuntime/partitions/SpritePartition
Response Body:
{}
This example uses the POST method to register existing partition in a runtime.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name":"SpritePartition",
"id":"4f138249-5e6b-40fe-9c42-a675f027cd9b"}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitions
Example Response
HTTP/1.1 201 Created
Location: http://localhost:7001/management/lifecycle/latest/runtimes/WLSTestRuntime/partitions/SpritePartition
Response Body:
{}
This resource manages a runtime partition.
The resource supports the following methods:
The DELETE method deletes the partition identified by the resource URL.
This example uses the DELETE method to delete a specific partition.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitions/SpritePartition
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns information about the partition identified by the resource URL.
The response body returned includes a RuntimePartition entity that contains information about the specified partition.
This method can return the following links:
uri=/lifecycle/{version}/environments/{environment-name}/partitions/{partition-name} rel=environment
uri=/lifecycle/{version}/tenants/{tenant-name} rel=tenant
This example uses the GET method to display information about a specific partition.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSTestRuntime/partitions/SpritePartition
Example Response
HTTP/1.1 200 OK
Response Body:
{
"name": "SpritePartition",
"id": "429aaa5a-058d-452d-b256-ce874d6e8583",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "environment",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/srpite",
"title": "name"
}
]
}
The POST method updates the partition identified by the resource URL.
This example uses the POST method to update a specific partition.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d "{"properties" : [
{ "name" : "resourceGroups",
"properties" : [
{ "name" : "g1",
"properties" : [
{ "name" : "useDefaultTarget", "value" : "false" }
]}
]}
]}" \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitions/SpritePartition
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource quiesces a runtime.
The resource supports the following methods:
The POST method performs a quiesce operation on the specified runtime.
This example uses the POST method to quiesce a runtime.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"phase": "", "properties" : [{"name": "managedserver", "value": "managedserver"}]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/quiesce
Example Response
HTTP/1.1 202 Accepted
Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/quiesce\/task\/managedserver\/_0_shutdown"
}]}
This resource manages a quiesce runtime task.
The resource supports the following methods:
The DELETE method cancels the task identified by the resource URL.
This example uses the DELETE method to cancel a specific task.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/quiesce/task/managedserver/_0_shutdown
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns the status of the task identified by the resource URL.
The response body returned includes a Task entity that contains information about the specified task.
This example uses the GET method to display information about a specific task.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/quiesce/task/managedserver/_0_shutdown
Example Response
HTTP/1.1 200 OK
Response Body:
{
"status": "TASK COMPLETED",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_0_shutdown"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_0_shutdown"
}
]
}
This resource is used to scale down a runtime.
The resource supports the following methods:
The POST method performs a scale down operation on the specified runtime. When you scale down a runtime, origin servers that are associated with the runtime are removed from the origin server pool.
This example uses the POST method to scale down a runtime.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"scaleFactor": "2", "properties" : [{"name": "cluster-name", "value" : "wls_cluster"]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/scaleDown
Example Response
HTTP/1.1 202 Accepted
Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management/lifecycle\/latest\/runtimes\/WLSRuntime\/scaleDown\/task\/wls-cluster\/ScaleDown_2"
}]}
This resource is used to scale up a runtime.
The resource supports the following methods:
The POST method performs a scale up operation on the specified runtime. When you scale up a runtime, Oracle Traffic Director creates new origin servers and adds them to the existing origin server pool.
This example uses the POST method to scale up a runtime.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"scaleFactor": "2", "properties" : [{"name": "cluster-name", "value" : "wls_cluster"]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/scaleUp
Example Response
HTTP/1.1 202 Accepted
Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/scaleUp\/task\/wls-cluster\/ScaleUp_1"
}]}
This resource manages a scaled up task.
The resource supports the following methods:
The DELETE method cancels the task identified by the resource URL.
This example uses the DELETE method to cancel a specific task.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/scaleUp/task/wls-cluster/ScaleUp_1
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns the status of the task identified by the resource URL.
The response body returned includes a Task entity that contains information about the specified task.
This example uses the GET method to display status information about a specific task.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/ScaleUp/task/wls-cluster/ScaleUp_1
Example Response
HTTP/1.1 200 OK
Response Body:
{
"status": "TASK COMPLETED",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/scaleDown\/task\/wls-cluster\/ScaleUp_1"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/scaleDown\/task\/wls-cluster\/ScaleUp_1"
}
]
}
This resource is used to start a runtime.
The resource supports the following methods:
The POST method performs a start operation on the specified runtime.
This example uses the POST method to start a runtime.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"phase": "", "properties" : [{"name": "managedserver", "value": "managedserver"}]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/start
Example Response
HTTP/1.1 202 Accepted
Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_1_start"
}]}
This resource manages a scaled up task.
The resource supports the following methods:
The DELETE method cancels the task identified by the resource URL.
This example uses the DELETE method to cancel a specific task.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/start/task/managedserver/_1_start
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns the status of the task identified by the resource URL.
The response body returned includes a Task entity that contains information about the specified task.
This example uses the GET method to display information about a specific task.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/start/task/managedserver/_1_start
Example Response
HTTP/1.1 200 OK
Response Body:
{
"status": "TASK COMPLETED",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_1_start"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_1_start"
}
]
}
This resource synchronizes the environment.
The resource supports the following methods:
The POST method synchronizes the runtime.
This example uses the POST method to synchronize the runtime.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -d '' \ -X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/sync
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource synchronizes all environments.
The resource supports the following methods:
The POST method synchronizes or configures periodic synchronization of all environments.
Synchronizes all environments. This example uses the POST method to synchronize all environments.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -d '' \ -X POST http://localhost:7001/management/lifecycle/latest/sync
Example Response
HTTP/1.1 200 OK
Response Body:
{}
Configure periodic synchronization of all environments. This example uses the POST method to configure periodic synchronization of all environments.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{
"sync": "true",
"syncInterval": "1"}' \
-X POST http://localhost:7001/management/lifecycle/latest/sync
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource describes the information needed to register a tenant.
The resource supports the following methods:
The response body returned includes a Tenant entity that contains information about fields that must be specified when registering a tenant.
This method can return the following links:
uri=/tenants rel=/tenants
The GET method on this resource returns an empty form for a tenant.
This example uses the GET method to get a tenant create form.
Example Request
curl -v \ --user admin:admin123 \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/tenantCreateForm
Example Response
HTTP/1.1 200 OK
Response Body:
{
"topLevelDir": null,
"name": null,
"id": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenantCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenantCreateForm"
},
{
"rel": "tenants",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
}
]
}
This resource manages tenants.
The resource supports the following methods:
The GET method on this resource returns a list of tenants.
The response body returned includes a collection of Tenant entities.
This example uses the GET method to display tenants.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/lifecycle/latest/tenants
Example Response
HTTP/1.1 200 OK
Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenants\/Sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenants\/Sprite"
}
],
"topLevelDir": "Sprite\/top\/level\/dir",
"name": "Sprite",
"id": "123"
}],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenants"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenants"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenantCreateForm"
}
]
}
The POST method registers a tenant.
This example uses the POST method to register a tenant.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"uuid" : "55ec0a13-7152-4040-8352-ad1e7726bad9", "name" : "Sprite", "topLevelDir": "Sprite/top/level/dir" }' \
-X POST http://localhost:7001/lifecycle/latest/tenants
Example Response
HTTP/1.1 201 Created
Location: http://localhost:7001/lifecycle/latest/tenants/Sprite
Response Body:
{}
This resource manages tenants.
The resource supports the following methods:
The DELETE method unregisters the tenant identified by the resource URL.
This example uses the DELETE method to unregister a specific tenant.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/tenants/Sprite
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns information about the tenant identified by the resource URL.
The response body returned includes a Tenant entity that contains information about the specified tenant.
This example uses the GET method to display information about a specific tenant.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/tenants/Sprite
Example Response
HTTP/1.1 200 OK
Response Body:
{
"topLevelDir": "Sprite\/top\/level\/dir",
"name": "Sprite",
"id": "123",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite"
},
{
"rel": "serviceCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/serviceCreateForm"
},
{
"rel": "services",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services"
}
]
}
The POST method updates the tenant identified by the resource URL.
This example uses the POST method to update a specific tenant.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"topLevelDir": "Sprite/top/level/dir" }' \
-X POST http://localhost:7001/management/lifecycle/latest/tenants/Sprite
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource describes information needed to on-board a tenant to a service.
The resource supports the following methods:
The response body returned includes a Service entity that contains information about fields that must be specified when on-boarding a tenant to a service.
This method can return the following links:
uri=/services rel=/services
The GET method on this resource returns an empty form for a service.
This example uses the GET method to get a service create form.
Example Request
curl -v \ --user admin:admin123 \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/tenants/sprite/serviceCreateForm
Example Response
HTTP/1.1 200 OK
Response Body:
{
"environmentRef": null,
"name": null,
"type": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/serviceCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/serviceCreateForm"
},
{
"rel": "services",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services"
}
]
}
This resource manages a tenant's services.
The resource supports the following methods:
The GET method on this resource returns a list of services of the tenant identified in the resource URL.
The response body returned includes a collection of Service entities.
This example uses the GET method to display services for a tenant.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services
Example Response
HTTP/1.1 200 OK
Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite"
}
],
"topLevelDir": "Sprite\/top\/level\/dir",
"name": "Sprite",
"id": "123"
}],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenantCreateForm"
}
]
}
The POST method on-boards a tenant to a service.
This example uses the POST method to on-board a tenant to a service.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"uuid" : "30ec0a13-7102-4040-8352-ad1e7726bad9", "name" : "HCMProd", "type" : "HCMService", "environmentRef" : "sprite", "topLevelDir": "sprite/top/level/dir"}' \
-X POST http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services
Example Response
HTTP/1.1 201 Created
Location: http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd
Response Body:
{}
This resource manages a tenant's service.
The resource supports the following methods:
The DELETE method removes a service for a tenant.
This example uses the DELETE method to remove a service for a tenant.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns information about the service identified by the resource URL.
The response body returned includes a Service entity that contains information about the specified service.
This example uses the GET method to display information about a specific service.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd
Example Response
HTTP/1.1 200 OK
Response Body:
{
"uuid": "30ec0a13-7102-4040-8352-ad1e7726bad9",
"topLevelDir": "sprite\/top\/level\/dir",
"environmentRef": "sprite",
"name": "HCMProd",
"type": "HCMService",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd"
},
{
"rel": "PDBCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDBCreateForm"
},
{
"rel": "PDB",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDB"
}
]
}
The POST method updates the service identified by the resource URL.
This example uses the POST method to update specific service.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d '{"topLevelDir": "sprite/top/level/dir"}' \
-X POST http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd
Example Response
HTTP/1.1 200 OK
Response Body:
{}
This resource manages PDB for a service.
The resource supports the following methods:
The DELETE method removes PDB from the service identified by the resource URL.
This example uses the DELETE method to remove PDB from a specified service.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd/PDB
Example Response
HTTP/1.1 200 OK
Response Body:
{}
The GET method on this resource returns information about the PDB for the service identified by the resource URL.
The response body returned includes a PDB entity that contains information about the specified service.
This example uses the GET method to display PDB information about a specific service.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd/PDB
Example Response
HTTP/1.1 200 OK
Response Body:
{
"status": "ACTIVE",
"name": "SpriteHCMPDBProd",
"id": "444",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDB"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDB"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDBCreateForm"
}
]
}
The POST method adds PDB for the service identified by the resource URL.
This example uses the POST method to add PDB for a service.
Example Request
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name" : "spriteHCMPDBProd", "id" : "444", "status" : "ACTIVE"}' \
-X POST http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd/PDB
Example Response
HTTP/1.1 201 Created
Location: http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd/PDB
Response Body:
{}
This resource describes information needed to add PDB to a service.
The resource supports the following methods:
The response body returned includes a PDB entity that contains information about fields that must be specified when adding PDB to a service.
This example uses the GET method to get the PDB create form.
Example Request
curl -v \ --user admin:admin123 \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/tenants/sprite/services/CRMProd/PDBCreateForm
Example Response
HTTP/1.1 200 OK
Response Body:
{
"status": "ACTIVE",
"name": null,
"id": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services\/CRMProd"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services\/CRMProd\/PDBCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services\/CRMProd\/PDBCreateForm"
},
{
"rel": "PDB",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services\/CRMProd\/PDB"
}
]
}