Adding a custom configuration¶

Note

This request is available to Myra agents only.

Note

A combination of type and name can be used once per scope. The same combination can exist on the domain and on each of its subdomains.

Note

The body does not include the attributes id, created and modified. The values for these attributes will be set by the system after the creation of the entry.

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

Description¶

The Add-Custom-Configuration request allows a Myra agent to document a non-standard setting that was applied for a domain of a customer.

Requirements¶

Values of the request: Domain-ID {domainId}

Objects: CustomConfigurationVO

Request¶

To add a custom configuration, the Domain-ID {domainId} needs to be added to the path of the request.

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

Attributes	Description	Values
`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. When it is `false`, the entry stays internal and the customer neither sees it in the list nor can request it directly. In the Myra App, the attribute has the Released label.	`true` `false`
`subDomainName`	Creates the entry on the given subdomain instead of on the domain. The subdomain must exist under the domain. In the Myra App, the attribute has the Subdomain label.	`string`

The system responds by returning the object CustomConfigurationVO with the information about the new entry.

Example¶

Example request body:

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

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
201	The request has succeeded and a new object has been created.
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.