PRprobely
API Collections

Attach staged collection to a target's API scan settings

Changed on

PUT /targets/<pk>/api-scan-settings/

Consumes a staged collection created via POST /api-collections/ and attaches it to an existing target (staged_collection_id plus optional selected_env_file and custom_api_parameters). The staged collection may have scope=None (targetless upload) or scope=this-scope — both are accepted.

Browser-auth configuration lives on the dedicated PUT /targets/<pk>/browser-authentication/ endpoint (BAW-1997).

put/targets/{id}/api-scan-settings/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/targets/{id}/api-scan-settings/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Request body

staged_collection_idstring required

ID of the staged Bruno collection to apply to the target's API scan settings.

selected_env_filestring

Base name (without path or extension) of the environment file from the staged collection to activate. Leave blank to use no environment file.

Response

auth_folderstring

Collection folder to use for the authentication request. The maximum length is 255 characters.

auth_var_mappingunknown
check_session_folderstring
authentication_enabledboolean
authentication_configuredboolean required

Indicates if authentication is configured for the target.

fail_fastboolean
selected_env_filestring
logout_detection_enabledboolean

Changes