SystemPropertiesResource


Create a system property


Create a system property

POST https://example.com/api/config/properties

Roles : [ROLE_SYSCONFIG_ALLOW_MODIFY]

Content-Type : systemproperty Accept : systemproperty

List system properties


Retrieve Abiquo system properties that are managed in Configuration view

GET https://example.com/api/config/properties

Roles : [ROLE_AUTHENTICATED, ROLE_SYSCONFIG_VIEW]

Parameter Type Default Value Description
name String If present, obtain only a single property identified by the property name
component String If present, obtain only properties related to a component, identified by the component name

Accept : systemproperties

Example

Update multiple system properties


Modify multiple system properties

PUT https://example.com/api/config/properties

Roles : [ROLE_SYSCONFIG_ALLOW_MODIFY]

Parameter Type Default Value Description
component String If present update only properties related to a component, identified by the component name

Content-Type : systemproperties Accept : systemproperties

Example

Delete a system property


DELETE https://example.com/api/config/properties/{property}

Roles : [ROLE_SYSCONFIG_ALLOW_MODIFY]

Get a system property


GET https://example.com/api/config/properties/{property}

Roles : [ROLE_SYSCONFIG_VIEW]

Accept : systemproperty

Error Codes

  • SYSPROP-0 - The requested system property does not exist

Example

Update a system property


PUT https://example.com/api/config/properties/{property}

Roles : [ROLE_SYSCONFIG_ALLOW_MODIFY]

Content-Type : systemproperty Accept : systemproperty

Example