configuration REST Endpoints

Sort by

Task Path Method

configuration

APIs affecting configuration elements. GET requests can be made by a client without the configuration lock, but any configuration request that changes the system configuration in any way—including saving, restoring, or activating it, plus POST, PUT, and DELETE—requires the REST client to first possess the configuration lock. Acquiring and releasing the lock are themselves both considered configuration operations.

Add a single configuration element instance

Method: post

Path: /rest/{version}/configuration/configElements

Add LST configuration.

Method: post

Path: /rest/{version}/configuration/lst/lstentry

Add LST XML File

Method: post

Path: /rest/{version}/configuration/lst/lstfile

Delete a configuration element and all its references

Method: delete

Path: /rest/{version}/configuration/configReferences

Delete a single configuration element instance

Method: delete

Path: /rest/{version}/configuration/configElements

Delete LST Entry from specified filename.

Method: delete

Path: /rest/{version}/configuration/lst/lstentry

Delete LST XML file.

Method: delete

Path: /rest/{version}/configuration/lst/lstfile

Get a list of all supported configuration element types

Method: get

Path: /rest/{version}/configuration/elementTypes

Get a template instance for a configuration element or sub-element type

Method: get

Path: /rest/{version}/configuration/elementTypes/template

Get configuration template for LST entry.

Method: get

Path: /rest/{version}/configuration/lst/lstentry

Get configuration template for LST XML File.

Method: get

Path: /rest/{version}/configuration/lst/lstfile

Get one or more configuration element instances

Method: get

Path: /rest/{version}/configuration/configElements

Get the boot parameters

Method: get

Path: /rest/{version}/configuration/bootparams

Get the list of saved LST Entries.

Method: get

Path: /rest/{version}/configuration/lst/lstentries

Get the list of saved LST XML Files.

Method: get

Path: /rest/{version}/configuration/lst/lstfiles

Get the metadata for a configuration element type

Method: get

Path: /rest/{version}/configuration/elementTypes/metadata

Lock the configuration

Method: post

Path: /rest/{version}/configuration/lock

Modify LST configuration.

Method: put

Path: /rest/{version}/configuration/lst/lstentry

Modify LST File secret.

Method: put

Path: /rest/{version}/configuration/lst/lstfile

Save, verify or refresh LST configuration

Method: put

Path: /rest/{version}/configuration/lst

Unlock the configuration

Method: post

Path: /rest/{version}/configuration/unlock

Update a single configuration element instance

Method: put

Path: /rest/{version}/configuration/configElements

Update the boot parameters

Method: put

Path: /rest/{version}/configuration/bootparams