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.
Create config modifier
Create a config modifier for a specific environment within a Redox organization. You can specify the details for a config modifier via API or the Redox dashboard (learn how to create a config modifier in the dashboard).
This endpoint allows you to create config modifier at a time.
cURL request example
Path Parameters
- environmentIdrequired, string
Identifies the specific environment that you're operating in or on behalf of.
Request Body Schema
- namerequired, string
Contains the human-readable name of the config modifier.
- flavorrequired, string
Indicates the type, or flavor, of config modifier. A
put
flavor alters data (creates or replaces) in a payload, while adelete
flavor removes something.Possible Values:put
,delete
- selectorrequired, string
Indicates the location(s) within the payload that this config modifier will operate on.
- schemaobject
Required for a
put
flavor config modifier. Indicates how to build the value at the location the selector specifies.
Contains the fields that you can populate to create a new or update an existing config modifier.
- metaobject
- versionstring
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.
- payloadobject
- configModifierobject
Contains a config modifier and its related details.
- idstring
Contains the unique identifier of the config modifier.
Format: uuid - versionnumber
Indicates the iteration, or version number, of the config modifier. Version numbers start at 1 and increment every time a config modifier is updated.
- namestring
Displays the human-readable name of the config modifier.
- flavorstring
Indicates the type, or flavor, of config modifier. A
put
flavor alters data (creates or replaces) in a payload, while adelete
flavor removes data from a payload.Possible Values:put
,delete
- selectorstring
Indicates the location(s) within the payload that this config modifier will operate on.
- schemaobject
Required for a
put
flavor config modifier. Indicates how to build the value at the location the selector specifies. - usageArray of object
- ownedBystring
Indicates whether the source or destination system owns the link. Only the owner can view the specific details or update a link.
Possible Values:source
,destination
- linkIdstring
Contains the unique identifier of the link for a specified asset.
Format: uuid - organizationobject
Describes the Redox organization that the asset belongs to.
- idnumber
Contains the unique identifier of the Redox organization.
- namenullable, string
Contains the human-readable name of the Redox organization.
- connectingOrganizationobject
Specifies the organization the asset is connected to when the subscription relates to a partner organization.
- idnumber
Contains the unique identifier of the Redox organization.
- namenullable, string
Contains the human-readable name of the Redox organization.
- processingLocationstring
Identifies where a link will be applied during log processing. There are up to four stages that an asset can be linked to, depending on whether you own either the source, the destination, or both.
Possible Values:source-request
,destination-request
,source-response
,destination-response
- subscriptionobject
- dataModelstring
Specifies the Redox data model that the link applies to or should apply to.
- sourceobject
Specifies the source of the subscription that an asset is or should be linked to.
- idrequired, string
Contains the unique identifier of the source.
Format: uuid - namenullable, string
Specifies the name of the source.
- destinationobject
Specifies the destination of the subscription that an asset is or should be linked to.
- idrequired, string
Contains the unique identifier of the destination.
Format: uuid - namenullable, string
Specifies the name of the destination.
- eventTypesArray of string
Specifies the event types of the given Redox data model that the link applies to. If
null
, the config modifier is linked to all event types of the data model.
- createdAtstring
Displays the date and time that the asset was originally created in ISO 8601 format.
- createdByobject
Contains the metadata about the user who created the asset.
- idnumber
Contains the unique identifier of the user.
- namenullable, string
Displays the user's full name.
- updatedAtstring
Displays the date and time that the asset was last updated in ISO 8601 format.
- updatedByobject
Contains the metadata about the user who last updated the asset.
- idnumber
Contains the unique identifier of the user.
- namenullable, string
Displays the user's full name.
- deletedAtnullable, string
Displays the date and time that the asset was deleted. Returns a
null
value if the asset hasn't been deleted. - deletedBynullable, object
Contains the metadata about the user who deleted the asset.
- idnumber
Contains the unique identifier of the user.
- namenullable, string
Displays the user's full name.
- environmentobject
Describes the Redox environment that the asset belongs to.
- idstring
Contains the unique identifier of the Redox environment.
Format: uuid
- organizationobject
Describes the Redox organization that the asset belongs to.
- idnumber
Contains the unique identifier of the Redox organization.
- namenullable, string
Contains the human-readable name of the Redox organization.