Home
API reference
Platform API reference
Platform API
Config modifiers
Delete config modifier

Delete config modifier

delete/v1/operations/configmodifiers/{configModifierId}
Page View

Config modifier endpoints allow you to review and manage config modifiers and their related links. Learn about config modifiers.

Anyone in a Redox organization can view config modifiers and related links, but you must be assigned to an engineer or support role to update them.

You can:

  • retrieve a list of config modifiers by environment or organization;
  • create config modifiers or links;
  • update config modifiers or links; or
  • delete config modifiers or link.

Delete config modifier

Delete an existing config modifier within a Redox organization.

Your organization must own the config modifier, and you must be assigned to an engineer or support role to use this endpoint.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/configmodifiers/{configModifierId}' \
2
--request DELETE \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • configModifierId
    required, string

    Displays the unique identifier of a config modifier.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "message": "string"
7
  }
8
}

    Describes the outcome of the delete request.

  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object
    • message
      string

      Explains that the delete request was successful, so the config modifier no longer exists.