Jump to

• Request
• Response

Deletes configuration property that is provided in the input.

delete

/config/property/v1

Whether property to be deleted exists or not a 200 response is returned. If no config property is provided in the input then this is function does not change anything in config properties, and a 200 response is returned. Only properties that are stored in the persistent store can be deleted. Properties that are sourced from product files and product environment cannot be deleted using this API. This API returns API Response. API response contains empty array of properties in all cases.

Request

Query Parameters

• propertyName(required): string
  Property name to delete. Property with name that is exact match with the input will be deleted if possible.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : ConfigAPIResponse

Type: object

Show Source

• responseCode(required): string
• responseMessage(required): string

{
    "required":[
        "responseCode",
        "responseMessage"
    ],
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

406 Response

Incorrect Data

Body ()

Root Schema : ConfigAPIResponse

Type: object

Show Source

• responseCode(required): string
• responseMessage(required): string

{
    "required":[
        "responseCode",
        "responseMessage"
    ],
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

Back to Top