Get Connect Profiles

Gets a list of available connect profiles.

HTTP Request

GET /api/sonar/connect-profiles
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/connect-profiles?offset=0&limit=20"
Request Parameters
KeyRequiredTypeDescriptionNote
offsetX32-bit integerNumber of records to skipDefault: 0
limitX32-bit integerMaximum number of records to loadDefault: 2147483647
typeXStringConnect profile typeSearch only by a specified profile type
keywordsXStringKeywordSearch available by code, name, description
company_guidXStringCompany GUIDOption only available for a cluster administrator

Success Response

{
  "total_count": 1,
  "profiles": [
    {
      "guid": "b7f00412-8720-4a8f-ac35-7d7f359f797e",
      "code": "build",
      "name": "Build SSH",
      "type": "ssh",
      "description": "",
      "company_guid": "6fbe27b7-f1ae-4d7a-a1a5-76d8fa9aa311",
      "company_name": "Logpresso",
      "configs": {
        "password": "",
        "port": 22,
        "host": "build",
        "server_alive_interval": null,
        "user": "logpresso",
        "timeout": 30
      },
      "config_description": "Host: build, Port: 22, User: xeraph, Auth Method: Password, Timeout: 30 secs",
      "factory_display_name": "SSH",
      "created": "2022-09-01 00:39:35+0900",
      "updated": "2022-09-01 00:39:35+0900",
      "grant_users": [
        {
          "type": "USER",
          "guid": "bfd00bb0-be99-4fd5-8380-166f544975fa",
          "name": "Joshua",
          "read_only": true,
          "created": "2022-09-02 19:38:21+0900"
        }
      ],
      "grant_groups": [
        {
          "type": "USER",
          "guid": "28c1251b-2f7c-4c58-95a1-fc4a1ead877e",
          "name": "dev",
          "read_only": true,
          "created": "2022-09-02 19:38:21+0900"
        }
      ],
      "protected_keys": ["password"]
    }
  ]
}
  • total_count (32-bit integer): Total number of the connect profiles that match the specified search keyword
  • profiles (Array): List of the connect profiles that match the specified search keyword
    • guid (String): Connect profile GUID
    • code (String): Code for query. Unique name among same connect profile type.
    • name (String): Display name of the connect profile
    • type (String): Connect profile type
    • description (String): Connect profile description
    • company_guid (String): GUID of the company to which the connect profile belongs
    • company_name (String): Name of the company to which the connect profile belongs
    • configs (Map): Connect profile Key/value pairs. Protected options, like password, do not return the original value, but rather an empty string indicating that they are set.
    • config_description (String): Connect profile option summary. Key information to identify a specific connect profile in the list.
    • factory_display_name (String): Display name of the connect profile. For example, the jdbc type returns database in Korean.
    • created (String): Date and time of creation (yyyy-MM-dd HH:mm:ssZ)
    • updated (String): Date and time of last modification (yyyy-MM-dd HH:mm:ssZ)
    • grant_users (Array): List of the users authorized to use connect profiles
      • type (String): Common object type. Always USER.
      • guid (String): User GUID
      • name (String): User name
      • read_only (Boolean): Whether read-only or not. Always false.
      • created (String): Date and time when privilege mappings are generated
    • grant_groups (Array): List of user groups with privilege for the connect profile
      • type (String): Common object type. Always USER.
      • guid (String): User group GUID
      • name (String): User group name
      • read_only (Boolean): Whether read-only or not. Always false.
      • created (String): Date and time when privilege mappings are generated
    • protected_keys (Array): List of the protected option key names. For example, the password setting is not returned because it is protected.

Error Responses

offset or limit value is not an integer

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}
offset or limit value is negative

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}
Identifier is not in valid GUID format

HTTP status code 400

{
  "error_code": "invalid-param-type",
  "error_msg": "company_guid should be guid type."
}