Disable Connect Profile Check

Disables the periodic connection check for the specified connect profiles. Pass multiple connect profile GUIDs in the body's guids parameter to disable them in a single call.

Tip

The `:guid` in the URL path exists only for routing and is not actually used. The list of profiles to disable is taken from the body's `guids` parameter.

Required Permissions

Requires the ADMIN role or higher.

HTTP Request

POST /api/sonar/connect-profiles/:guid/disable-connection-check

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     -d "guids=b7f00412-8720-4a8f-ac35-7d7f359f797e,77e0aa85-14d3-43a9-ab23-4dc97dfc185e" \
     -X POST \
     https://HOSTNAME/api/sonar/connect-profiles/b7f00412-8720-4a8f-ac35-7d7f359f797e/disable-connection-check

Request Parameters

Path Parameters

Key	Type	Description	Notes
guid	String	Connect profile GUID	Used only for routing. The actual targets come from `guids`.

Request Body Parameters

Key	Required	Type	Description	Notes
guids	O	String	GUID list of connect profiles to disable	Comma-separated list

Success Response

{
  "failures": []
}

When some connect profiles cannot be disabled, the failure entries are returned in the failures array.

{
  "failures": [
    {
      "guid": "b7f00412-8720-4a8f-ac35-7d7f359f797e",
      "reason": "profile not found"
    }
  ]
}

failures (Array): List of connect profiles for which the connection check could not be disabled. Returns an empty array when all profiles succeed.
- guid (String): GUID of the connect profile that failed
- reason (String): Failure reason

Error Responses

Required argument is missing

HTTP status code 400

{
  "error_code": "null-argument",
  "error_msg": "guids should be not null"
}

Identifier is not in valid GUID format

HTTP status code 400

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

Permission denied

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}