Get Connect Profile Options

Retrieves option specification for a specified connect profile type.

HTTP Request

GET /api/sonar/connect-profile-types/:type/options
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/connect-profile-types/ssh/options
Request Parameter
KeyRequiredTypeDescriptionNote
typeOStringConnect profile type identifier

Success Response

{
  "options": [
    {
      "type": "string",
      "subtype": "connection-string",
      "name": "connection_string",
      "required": true,
      "display_name": "Connection String",
      "description": "",
      "default_value": null,
      "protected": false
    },
    {
      "type": "string",
      "subtype": null,
      "name": "user",
      "required": false,
      "display_name": "User",
      "description": "",
      "default_value": null,
      "protected": false
    },
    {
      "type": "string",
      "subtype": null,
      "name": "password",
      "required": false,
      "display_name": "Password",
      "description": "",
      "default_value": null,
      "protected": true
    },
    {
      "type": "boolean",
      "subtype": null,
      "name": "read_only",
      "required": false,
      "display_name": "Read Only",
      "description": "Read Only",
      "default_value": "false",
      "protected": false
    }
  ]
}
  • options (Array): List of options
    • type (String): Data type. One of the following: string, integer, boolean.
    • subtype (String): Extension component type in the UI
    • name (String): Option key
    • required (Boolean): whether the option is required or not
    • display_name (String): Display name in locale language
    • description (String): Description in locale language
    • default_value (String): Default value to display on screen
    • protected (Boolean): Whether protected or not. Set to true for options like "password" that should not be visible when retrieving the profile.

Error Responses

Profile type does not exist
{
  "options": null
}