Getting a custom configuration¶

Note

An entry that Myra has not released for the customer and an entry that belongs to another domain are both answered with a 403 HTTP code.

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

Description¶

The Get-Custom-Configuration request allows the user to request a single custom configuration that Myra has applied for a domain of the organisation.

Requirements¶

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

Objects: none

Request¶

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

As a result, the user gets an object CustomConfigurationVO with the requested information.

The object provides the following information:

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, the accepted content depends on the type. In the Myra App, the attribute has the Value label.	`string`
`description`	An explanation of why the setting was applied. In the Myra App, the attribute has the Description label.	`string`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

{
  "objectType": "string",
  "type": "string",
  "name": "string",
  "value": "string",
  "description": "string",
  "id": 0,
  "modified": "string",
  "created": "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.