Get excluded targets for a profile

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves the list of devices and groups excluded from a profile's distribution target. Returns excluded device IDs/names and excluded group IDs/names/types.

Request URL

https://{server-hostname}:8383/bsp/api/v1/bmp/profiles/{profile_id}/targets/exclude Copied!

Scope

BrowserManager.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Retrieve the configuration profile ID from the profileid key in the response returned by List Configuration Profiles

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/bsp/api/v1/bmp/profiles/{profile_id}/targets/exclude \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Response containing excluded devices and groups for a profile's distribution target

Hide Sub-Attributes
excluded_devicesJSON Array

Devices that are explicitly excluded from receiving this profile

Show Sub-Attributes
JSON Object

Excluded device entry

Show Sub-Attributes
idlong

Device resource ID

namestring

Device name

idlong

Device resource ID

namestring

Device name

excluded_groupsJSON Array

Device groups that are explicitly excluded from receiving this profile

Show Sub-Attributes
JSON Object

Excluded group entry

Show Sub-Attributes
idlong

Group resource ID

namestring

Group name

typeinteger

Group type. 1=Static, 7=Dynamic

idlong

Group resource ID

namestring

Group name

typeinteger

Group type. 1=Static, 7=Dynamic

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

Unauthorized error code: API key or OAuth token missing, expired or invalid

error_descriptionstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

Forbidden error code: the user lacks the required MDM_OSUpdateMgmt UEM role

error_descriptionstring

Message indicating insufficient privileges

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

Rate limit error code: API call threshold exceeded for this endpoint group

error_descriptionstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object

Internal server error response for profile operations

Hide Sub-Attributes
error_descriptionstring

Error message describing the server failure

error_codestring

Error code for internal server errors

Sample Response: HTTP 200

Profile with excluded devices and groups

Copied!
  {
    "excluded_groups": [
      {
        "name": "Test Lab Machines",
        "id": 401,
        "type": 1
      },
      {
        "name": "Kiosk Devices",
        "id": 402,
        "type": 7
      }
    ],
    "excluded_devices": [
      {
        "name": "DESKTOP-MARKETING-01",
        "id": 301
      },
      {
        "name": "LAPTOP-HR-05",
        "id": 302
      }
    ]
  }
                
▼ Show full

Profile with no exclusions configured

Copied!
  {
    "excluded_groups": [],
    "excluded_devices": []
  }
                
▼ Show full

Sample Response: HTTP 401

Unauthorized

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
▼ Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }
                
▼ Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }
                
▼ Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }
                
▼ Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.