Changing a custom configuration¶

Note

This request is available to Myra agents only.

Warning

The optional attributes are reset when they are not sent. An entry keeps its ticket number, its description, its release state and its subdomain only when the request repeats them.

Sends a PUT request to the endpoint /domain/{domainId}/custom-configurations/{id}.

Description¶

The Change-Custom-Configuration request allows a Myra agent to change a documented non-standard setting of a domain of a customer.

Requirements¶

Values of the request: Domain-ID {domainId}, Custom-Configuration-ID {id}

Objects: CustomConfigurationVO

Request¶

To change a custom configuration, the Domain-ID {domainId} and the Custom-Configuration-ID {id} need to be added to the path of the request.

For a detailed specification of which information is required to change a custom configuration, the object CustomConfigurationVO with the following attributes needs to be defined in the body:

Attributes	Description	Values
`id`	The ID of the entry. It must match the Custom-Configuration-ID in the path.	`integer`
`modified`	The last modification date the entry was read with, in ISO 8601 format. The request is rejected when the entry has been changed in the meantime.	`string($date-time)`
`type`	The kind of setting the entry describes. In the Myra App, the attribute has the Type label.	`feature` `header` `ssl_cipher`
`name`	The name of the setting. In the Myra App, the attribute has the Name label.	`string`
`value`	The value of the setting. Free text, no format restriction is applied. In the Myra App, the attribute has the Value label.	`string`

The following attributes are optional:

Attributes	Description	Values
`description`	An explanation of why the setting was applied. In the Myra App, the attribute has the Description label.	`string`
`ticketNumber`	The ticket the setting was requested in. In the Myra App, the attribute has the Ticket label.	`string`
`read`	Releases the entry for the customer. In the Myra App, the attribute has the Released label.	`true` `false`
`subDomainName`	Moves the entry to the given subdomain. Omitting it moves the entry to the domain level. In the Myra App, the attribute has the Subdomain label.	`string`

The system returns the object CustomConfigurationVO with the changed information.

Example¶

Example request body:

{
  "id": 0,
  "modified": "string",
  "type": "string",
  "name": "string",
  "value": "string",
  "description": "string",
  "ticketNumber": "string",
  "read": true,
  "subDomainName": "string"
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.