Deploy configuration profiles to specific devices

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

Associates one or more published configuration profiles to specific devices for deployment. Both profile_ids and device_ids arrays are required with a maximum of 1000 items each. Only published profiles (status 110) can be associated.

Request URL

https://{server-hostname}:8383/bsp/api/v1/bmp/profiles/devices

Scope

BrowserManager.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Request Body

JSON body containing profile_ids and device_ids arrays for profile-to-device association

application/json
JSON Object

Request body for associating profiles to devices

Hide Sub-Attributes
device_idsarrayOptional

Required. Device resource IDs from List Devices response (device_id field). Max 1000

profile_idsarrayOptional

Profile IDs from List Profiles response (profile_id field). Max 1000, only published profiles allowed

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/profiles/devices \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"device_ids":[999,888],"profile_ids":[111]}'

Sample Request Body

Associate two profiles to two devices

Copied!
  {
    "device_ids": [
      999,
      888
    ],
    "profile_ids": [
      111
    ]
  }
                
Show full

Response Parameters

- HTTP code 204

Response Body - application/json

- HTTP code 400

Response Body - application/json
JSON Object

Bad request error for invalid input or constraint violations

Hide Sub-Attributes
errorcodestring

Error code identifying the specific validation failure

errormsgstring

Message describing the validation failure

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 404

Response Body - application/json
JSON Object

Resource not found error

Hide Sub-Attributes
errormsgstring

Not found error message

- HTTP code 409

Response Body - application/json
JSON Object

Conflict error due to the current state of the profile

Hide Sub-Attributes
errormsgstring

Conflict error message

- HTTP code 429

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

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

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

Possible Response Codes

204HTTP code

Returns 204 No Content on success.

400HTTP code
401HTTP code
403HTTP code
404HTTP code
409HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 204

Copied!
204 Returns 204 No Content on success.
Show full

Sample Response: HTTP 400

Invalid request parameters

Copied!
  {
    "errorcode": "IAM0003",
    "errormsg": "Invalid request."
  }
                
Show full

Sample Response: HTTP 401

API key is missing or invalid

Copied!
  {
    "errorCode": "IAM0001",
    "errorMsg": "Authentication key is invalid. Please regenerate the key and try again."
  }
                
Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "User does not have permission to perform this operation"
  }
                
Show full

Sample Response: HTTP 404

The specified profile does not exist or is in trash

Copied!
  {
    "errormsg": "Profile not found"
  }
                
Show full

Sample Response: HTTP 409

Profile must be published before it can be associated to devices

Copied!
  {
    "errormsg": "Profile is not published."
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "Too many requests. Please try again after 5 minutes"
  }
                
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.