Configuration Templates via REST

The Configuration Template framework is REST-native and provides all necessary endpoints to manage Configuration Templates and instances. The respective REST calls can be integrated into any state-of-the-art technology that can handle REST calls.

Before You Begin

Before you send REST calls to your Control Center, you must enable the REST-API services. For more information on how to enable the REST-API service, see REST API.

Accessing the REST Endpoints

The access to a REST endpoint consists of two parts which build the complete call:

Connection to the respective Control Center: https://<CC-IP>:8443/rest/cc/v1 where <CC-IP> is a placeholder for the IP address of the Control Center.
Effective endpoint: the URL's content has to be completed by one of the following endpoints listed in the table below, such as /ranges/..... .

The following table gives an overview of all available REST calls. The content of the column Endpoint has to be appended to the first part (1) of the URL content.

Action	HTTP Method	Endpoint

Action	HTTP Method	Endpoint
Create a ConfTemplate	POST	`/ranges/<range>/clusters/<cluster>/conftemplates`
List ConfTemplates in the given cluster	GET	`/ranges/<range>/clusters/<cluster>/conftemplates`
Get the template definition of the given ConfTemplate	GET	`/ranges/<range>/clusters/<cluster>/conftemplates/<conftemplate>`
Update the specified ConfTemplate	PUT	`/ranges/<range>/clusters/<cluster>/conftemplates/<conftemplate>`
Delete the specified ConfTemplate	DELETE	`/ranges/<range>/clusters/<cluster>/conftemplates/<conftemplate>`
Lock the specified ConfTemplate	POST	`/ranges/<range>/clusters/<cluster>/conftemplates/<conftemplate>/lock`
Get information about the specified ConfTemplate-lock	GET	`/ranges/<range>/clusters/<cluster>/conftemplates/<conftemplate>/lock`
Delete the specified ConfTemplate-lock	DELETE	`/ranges/<range>/clusters/<cluster>/conftemplates/<conftemplate>/lock`
Create an instance configured via ConfTemplates	POST	`/ranges/<range>/clusters/<cluster>/boxes`
Get information about an instance	GET	`/ranges/<range>/clusters/<cluster>/boxes/<box>`
Update an instance	PUT	`/ranges/<range>/clusters/<cluster>/boxes/<box>`
Partially update an instance	PATCH	`/ranges/<range>/clusters/<cluster>/boxes/<box>`
Delete an instance	DELETE	`/ranges/<range>/clusters/<cluster>/boxes/<box>`
Lock an instance	POST	`/ranges/<range>/clusters/<cluster>/boxes/<box>/lock`
Get information about an instance-lock	GET	`/ranges/<range>/clusters/<cluster>/boxes/<box>/lock`
Delete an instance-lock	DELETE	`/ranges/<range>/clusters/<cluster>/boxes/<box>/lock`
Lists available ConfUnit types	GET	`/confunittypes`
Show JSON schema specification of the given ConfUnit	GET	`/confunittypes/<confunittype>`

Example

Use Case	REST Call

Use Case	REST Call
In order to list all available types of configuration units, enter the following string into the URL edit-field of your browser. Replace `<CC-IP>` by your CC IP address.	`https://<CC-IP>:8443/rest/cc/v1/confunittypes`