Resources

Controller :: Management

Retrieve all Server Templates

GET /controller/management/servers
Responses
HTTP Code Description Schema

200

successful operation

400

Controller exception

No Content

404

Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers
Example HTTP response
Response 200
{
  "serverTemplates" : [ {
    "id" : "string",
    "name" : "string",
    "containersSpec" : [ {
      "id" : "string",
      "containerName" : "string",
      "serverTemplateKey" : {
        "id" : "string",
        "name" : "string"
      },
      "releasedId" : {
        "groupId" : "string",
        "artifactId" : "string",
        "version" : "string"
      },
      "configs" : {
        "string" : "<<_containerconfig>>"
      },
      "status" : "CREATING"
    } ],
    "configs" : {
      "string" : "<<_serverconfig>>"
    },
    "capabilities" : [ "string" ],
    "serverInstanceKeys" : [ {
      "serverInstanceId" : "string",
      "serverName" : "string",
      "serverTemplateId" : "string",
      "url" : "string"
    } ]
  } ]
}

Retrieve Server Template for a given id

GET /controller/management/servers/{id}
Parameters
Type Name Schema

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

200

successful operation

400

Controller exception

No Content

404

Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}
Example HTTP response
Response 200
{
  "id" : "string",
  "name" : "string",
  "containersSpec" : [ {
    "id" : "string",
    "containerName" : "string",
    "serverTemplateKey" : {
      "id" : "string",
      "name" : "string"
    },
    "releasedId" : {
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    },
    "configs" : {
      "string" : "<<_containerconfig>>"
    },
    "status" : "CREATING"
  } ],
  "configs" : {
    "string" : "<<_serverconfig>>"
  },
  "capabilities" : [ "string" ],
  "serverInstanceKeys" : [ {
    "serverInstanceId" : "string",
    "serverName" : "string",
    "serverTemplateId" : "string",
    "url" : "string"
  } ]
}

Add new Server Template to Controller

PUT /controller/management/servers/{id}
Parameters
Type Name Schema

Path

Kie Server Template identifier
required

string

Body

Kie Server Template information
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}
Request body
{
  "server-id" : "sample-server",
  "server-name" : "sample-server",
  "capabilities" : [
       "RULE",       "PROCESS",       "PLANNING"    ],
  "container-specs" : [ ],
  "server-config" : { }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<server-template-details>
  <server-id>sample-server</server-id>
  <server-name>sample-server</server-name>
  <configs/>
  <capabilities>RULE</capabilities>
  <capabilities>PROCESS</capabilities>
  <capabilities>PLANNING</capabilities>
</server-template-details>

Remove Server Template

DELETE /controller/management/servers/{id}
Parameters
Type Name Schema

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

404

Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}

Retrieve all Container Specification for a Server Template

GET /controller/management/servers/{id}/containers
Parameters
Type Name Schema

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

200

successful operation

400

Controller exception

No Content

404

Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers
Example HTTP response
Response 200
{
  "containerSpecs" : [ {
    "id" : "string",
    "containerName" : "string",
    "serverTemplateKey" : {
      "id" : "string",
      "name" : "string"
    },
    "releasedId" : {
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    },
    "configs" : {
      "string" : "<<_containerconfig>>"
    },
    "status" : "CREATING"
  } ]
}

Update Container Specification in a given Server Template

POST /controller/management/servers/{id}/containers/{containerId}
Parameters
Type Name Schema

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Body

Container information
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

404

Server Template or Container not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers/{containerId}
Request body
{
  "container-id" : "evaluation_1.0.0-SNAPSHOT",
  "container-name" : "evaluation",
  "release-id" : {
       "group-id" : "evaluation",
        "artifact-id" : "evaluation",
        "version" : "1.0.0-SNAPSHOT"
    },
  "configuration" : null,
  "status" : "STARTED"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<container-spec-details>
    <container-id>evaluation_1.0.0-SNAPSHOT</container-id>
    <container-name>evaluation</container-name>
    <release-id>
        <artifact-id>evaluation</artifact-id>
        <group-id>evaluation</group-id>
        <version>1.0.0-SNAPSHOT</version>
    </release-id>
    <status>STARTED</status>
</container-spec-details>

Get Container Specification for a given id and Server Template

GET /controller/management/servers/{id}/containers/{containerId}
Parameters
Type Name Schema

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

200

successful operation

400

Controller exception

No Content

404

Container Specification or Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers/{containerId}
Example HTTP response
Response 200
{
  "id" : "string",
  "containerName" : "string",
  "serverTemplateKey" : {
    "id" : "string",
    "name" : "string"
  },
  "releasedId" : {
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string"
  },
  "configs" : {
    "string" : "<<_containerconfig>>"
  },
  "status" : "CREATING"
}

Add new Container Specification to a given Server Template

PUT /controller/management/servers/{id}/containers/{containerId}
Parameters
Type Name Schema

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Body

Container information
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

404

Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers/{containerId}
Request body
{
  "container-id" : "evaluation_1.0.0-SNAPSHOT",
  "container-name" : "evaluation",
  "release-id" : {
       "group-id" : "evaluation",
        "artifact-id" : "evaluation",
        "version" : "1.0.0-SNAPSHOT"
    },
  "configuration" : null,
  "status" : "STARTED"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<container-spec-details>
    <container-id>evaluation_1.0.0-SNAPSHOT</container-id>
    <container-name>evaluation</container-name>
    <release-id>
        <artifact-id>evaluation</artifact-id>
        <group-id>evaluation</group-id>
        <version>1.0.0-SNAPSHOT</version>
    </release-id>
    <status>STARTED</status>
</container-spec-details>

Remove Container Specification from a given Server Template

DELETE /controller/management/servers/{id}/containers/{containerId}
Parameters
Type Name Schema

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

404

Container Specification or Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers/{containerId}

Update Container Specification for a given id and Server Template

POST /controller/management/servers/{id}/containers/{containerId}/config/{capability}
Parameters
Type Name Schema

Path

Container capability
required

string

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Body

Container configuration
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

404

Container Specification or Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers/{containerId}/config/{capability}
Request body
{
"org.kie.server.controller.api.model.spec.ProcessConfig" : {
       "runtimeStrategy" : "SINGLETON",
       "kbase" : null,
       "ksession" : null,
       "mergeMode" : "MERGE_COLLECTIONS"
  }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<process-config>
    <runtimeStrategy>SINGLETON</runtimeStrategy>
    <mergeMode>MERGE_COLLECTIONS</mergeMode>
</process-config>

Activate Container for a given id and Server Template

POST /controller/management/servers/{id}/containers/{containerId}/status/activated
Parameters
Type Name Schema

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

404

Container or Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers/{containerId}/status/activated

Deactivate Container for a given id and Server Template

POST /controller/management/servers/{id}/containers/{containerId}/status/deactivated
Parameters
Type Name Schema

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

404

Container or Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers/{containerId}/status/deactivated

Start Container for a given id and Server Template

POST /controller/management/servers/{id}/containers/{containerId}/status/started
Parameters
Type Name Schema

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

404

Container or Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers/{containerId}/status/started

Stop Container for a given id and Server Template

POST /controller/management/servers/{id}/containers/{containerId}/status/stopped
Parameters
Type Name Schema

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

400

Controller exception

No Content

404

Container or Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/management/servers/{id}/containers/{containerId}/status/stopped

Controller :: Runtime

Retrieve all Containers with a given id in Kie Server instances from a specific Server Template

GET /controller/runtime/servers/{id}/containers/{containerId}/instances
Parameters
Type Name Schema

Path

Container identifier
required

string

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

200

successful operation

400

Controller exception

No Content

404

Server Template or Kie Server instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/runtime/servers/{id}/containers/{containerId}/instances
Example HTTP response
Response 200
{
  "containers" : [ {
    "serverTemplateId" : "string",
    "containerSpecId" : "string",
    "containerName" : "string",
    "url" : "string",
    "serverInstanceId" : "string",
    "resolvedReleasedId" : {
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    },
    "messages" : [ {
      "severity" : "INFO",
      "timestamp" : "1970-01-01T00:00:00Z",
      "messages" : [ "string" ]
    } ],
    "status" : "CREATING",
    "serverInstanceKey" : {
      "serverInstanceId" : "string",
      "serverName" : "string",
      "serverTemplateId" : "string",
      "url" : "string"
    }
  } ]
}

Retrieve all Kie Server instances connected to the controller for a given Server Template

GET /controller/runtime/servers/{id}/instances
Parameters
Type Name Schema

Path

Kie Server Template identifier
required

string

Responses
HTTP Code Description Schema

200

successful operation

400

Controller exception

No Content

404

Server Template not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/runtime/servers/{id}/instances
Example HTTP response
Response 200
{
  "serverInstanceKeys" : [ {
    "serverInstanceId" : "string",
    "serverName" : "string",
    "serverTemplateId" : "string",
    "url" : "string"
  } ]
}

Retrieve all Containers for a given Kie Server instance

GET /controller/runtime/servers/{id}/instances/{instanceId}/containers
Parameters
Type Name Schema

Path

Kie Server Template identifier
required

string

Path

Kie Server instance identifier
required

string

Responses
HTTP Code Description Schema

200

successful operation

400

Controller exception

No Content

404

Server Template or Kie Server instance not found

No Content

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/runtime/servers/{id}/instances/{instanceId}/containers
Example HTTP response
Response 200
{
  "containers" : [ {
    "serverTemplateId" : "string",
    "containerSpecId" : "string",
    "containerName" : "string",
    "url" : "string",
    "serverInstanceId" : "string",
    "resolvedReleasedId" : {
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    },
    "messages" : [ {
      "severity" : "INFO",
      "timestamp" : "1970-01-01T00:00:00Z",
      "messages" : [ "string" ]
    } ],
    "status" : "CREATING",
    "serverInstanceKey" : {
      "serverInstanceId" : "string",
      "serverName" : "string",
      "serverTemplateId" : "string",
      "url" : "string"
    }
  } ]
}

Controller :: Server Controller

Connect a new Kie Server instance to Controller

PUT /controller/server/{id}
Parameters
Type Name Schema

Path

Kie Server instance identifier
required

string

Body

Kie Server instance information
required

string

Responses
HTTP Code Description Schema

200

successful operation

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/server/{id}
Request body
{
  "id" : "sample-server",
  "version" : "7.14.0-SNAPSHOT",
  "name" : "sample-server",
  "location" : "http://localhost:8080/kie-server/services/rest/server",
  "capabilities" : [
       "KieServer",       "BRM",       "BPM",       "CaseMgmt",       "BPM-UI",       "BRP",       "DMN",       "Swagger"    ],
  "messages" : null
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<kie-server-info>
  <id>sample-server</id>
  <version>7.14.0-SNAPSHOT</version>
  <name>sample-server</name>
  <location>http://localhost:8080/kie-server/services/rest/server</location>
  <capabilities>KieServer</capabilities>
  <capabilities>BRM</capabilities>
  <capabilities>BPM</capabilities>
  <capabilities>CaseMgmt</capabilities>
  <capabilities>BPM-UI</capabilities>
  <capabilities>BRP</capabilities>
  <capabilities>DMN</capabilities>
  <capabilities>Swagger</capabilities>
</kie-server-info>
Example HTTP response
Response 200
{
  "serverConfig" : {
    "configItems" : [ {
      "name" : "string",
      "value" : "string",
      "type" : "string"
    } ]
  },
  "containers" : [ {
    "containerId" : "string",
    "releaseId" : {
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    },
    "resolvedReleaseId" : {
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    },
    "status" : "CREATING",
    "scanner" : {
      "status" : "UNKNOWN",
      "pollInterval" : 0
    },
    "configItems" : [ {
      "name" : "string",
      "value" : "string",
      "type" : "string"
    } ],
    "messages" : [ {
      "severity" : "INFO",
      "timestamp" : "1970-01-01T00:00:00Z",
      "messages" : [ "string" ]
    } ],
    "containerAlias" : "string"
  } ]
}

Remove a Kie Server instance from Controller

DELETE /controller/server/{id}
Parameters
Type Name Schema

Path

Kie Server instance identifier
required

string

Query

Kie Server instance URL
required

string

Responses
HTTP Code Description Schema

500

Unexpected error

No Content

Consumes
  • application/xml

  • application/json

Example HTTP request
Request path
/controller/server/{id}?Kie Server instance URL=string