Favicon

You are here: Home > API Reference > Windows > Windows Devices > Retrieve agent configuration assets and certificates.

GET /organizations/:organizationId/mdm/windows/enterprise/devices/:winDeviceId/agent-config-assets

Required Permission: mdm.windows.device.get

Provides access to necessary configuration files and certificates required by the agent to establish secure communication with platform servers successfully.

GET
https://api.applivery.io/v1/organizations/{organizationId}/mdm/windows/enterprise/devices/{winDeviceId}/agent-config-assets 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/windows/enterprise/devices/{winDeviceId}/agent-config-assets" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/windows/enterprise/devices/{winDeviceId}/agent-config-assets", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/windows/enterprise/devices/{winDeviceId}/agent-config-assets",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
winDeviceId string
required
Windows device identifier used for targeting operations, supporting MongoDB ObjectId, IMEI, or serial number formats for flexible device lookup.
Match pattern: ^(([a-fA-F0-9]{24})|(\w{1,}))$

Responses

200 Response application/json
status boolean required
data object required
config object required
General configuration settings object containing key information for agent behavior and communication parameters required for operation and connection stability.
organizationInfo object required
Organization details object providing context for the device enrollment and branding information for the user interface customization display settings.
id string required
Unique identifier of the organization providing the context for device enrollment and management within compliance boundaries.
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
Display name of the organization shown in the agent interface to identify the managing entity to the user clearly.
≤ 128 characters
slug string required
URL-friendly string identifier for the organization used in API endpoints and resource URLs for configuration retrieval operations.
≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-z0-9][a-z0-9-]+[a-z0-9]$
branding object required
Object containing visual branding assets such as logos and colors to customize the agent appearance for the user interface.
contact object required
Contact information object for support inquiries allowing users to reach organization administrators in case of device issues or error reports.
createdBy string required
Identifier of the system or administrator that generated this organization configuration to track origin and responsibility information for audit logs.
applications array [object] required
List of applications assigned to the device with installation details and action requirements for software management enforcement and compliance checks.
winApplicationId string required
Unique identifier for the Windows application record in the system catalog used for tracking installation and compliance status updates.
Match pattern: ^[a-fA-F0-9]{24}$
type string required
Classification of the application package type such as MSI or Store App determining deployment strategy and installation requirements.
store build asset lastBuild lastGitBranchBuild lastGitTagBuild lastTagBuild
statusInfo object required
Object containing boolean flags indicating the current installation state and desired state of the application on the device endpoint system.
managedBy string required
Indicates which system component or policy is responsible for managing this application assignment and enforcements on the device endpoint.
agent mdm
action string required
Specifies the required action for the application such as install or uninstall based on policy assignment rule execution logic.
forceInstall available
manifest object optional
Application manifest data containing package metadata and installation definitions required for successful deployment to the device endpoint.
info object required
Information object providing display details like name, description, and version for the application displayed to the user interface views.
build object optional
Build artifact details including file identifier and extension for the specific version of the application package binary file content.
updatePolicy object required
Configuration settings defining how application updates are handled, including frequency and version constraints for the device agent logic rule execution.
bookmarks object required
Collection of managed bookmarks categorized by source to be provisioned in browsers or the agent interface for user access.
applivery array [object] required
custom array [object] required
appBlacklist array required
List of forbidden applications that the agent should monitor and restrict execution of to maintain security compliance and posture enforcement.
assets array [object] required
Array of assorted configuration files and resources required by the agent for specific policy or script execution and operation implementation.
id string required
Unique identifier for the configuration asset or resource file required by the agent for operation or deployment task completion.
Match pattern: ^[a-fA-F0-9]{24}$
location string optional
Storage path or URL where the asset can be retrieved by the agent for local caching and use.
≤ 256 characters
type string optional
Classification of the asset type such as certificate, script, or config determining how the agent processes it correctly.
≤ 128 characters
extension string optional
File extension of the asset indicating format such as ps1 or cer for appropriate handling by the agent logic.
≤ 128 characters
assetName string optional
Filename or display name of the asset used for identification and logging purposes within the agent operations and reports.
≤ 256 characters
scope string optional
Scope of the asset application such as user or system level confirming where the configuration should be applied correctly.
user system all-users
createdAt string optional
Timestamp when the asset was created or uploaded to the system establishing its version age for synchronization logic checks.
{
    "status": true,
    "data": {
        "config": {
            "serverUrl": "https://mdm.company.com",
            "pollInterval": 300
        },
        "organizationInfo": {
            "id": "507f1f77bcf86cd799439014",
            "name": "Acme Corporation",
            "slug": "acme-corp",
            "branding": {
                "logo": "https://cdn.company.com/logo.png",
                "primaryColor": "#0066CC"
            },
            "contact": {
                "email": "[email protected]"
            },
            "createdBy": "admin-123"
        },
        "applications": [],
        "bookmarks": {
            "applivery": [],
            "custom": [
                {
                    "title": "Intranet",
                    "url": "https://intranet.company.com"
                }
            ]
        },
        "appBlacklist": [
            "malware.exe",
            "unauthorized-tool.msi"
        ],
        "assets": []
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4001
message string optional
Unauthorized
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}