CIPP icon

CIPP

CIPP-API is an Azure Function App providing the logic layer for the CIPP platform. This spec is auto-generated via static analysis of both the API (PowerShell) and frontend (React/Next.js) repositories. Last generated: 2026-03-02.

Actions75

EndpointAutopilot → AddAPDevice

AI-generated

Overview

This node operation adds Autopilot devices to a tenant via the Partner Center API. It is useful for IT administrators or automation workflows that need to programmatically register devices for Windows Autopilot deployment in a specified tenant environment. For example, it can be used to automate the onboarding of new devices into an organization's Autopilot deployment system by providing tenant filtering and device-specific Autopilot data.

Use Case Examples

  1. Automate adding new Windows Autopilot devices to a tenant for streamlined device provisioning.
  2. Integrate with device inventory systems to batch register devices into Autopilot using tenant filters and device data.

Properties

Name Meaning
Tenant Filter The tenant filter used to specify the target tenant for the Autopilot device addition.
Autopilot Data The Autopilot data associated with the device to be added.
Groupname The group name to associate with the Autopilot device.
Custom Body Optional arbitrary JSON to send in the request body, which will be deep-merged with other fields (custom body values take priority). Leave empty to skip.
Custom Headers Custom HTTP headers to add to the request.
Query Filters Query-string filters to add to the request URL.
Batching Batch settings to group input items and control request intervals to avoid rate limiting.
Debug When enabled, includes detailed debug information about the API request in the output.
Pagination Settings to configure how pagination is handled for list operations.
Timeout Time in milliseconds to wait for the server response before aborting the request.

Output

JSON

  • debug - Debug information including the actual URL, query parameters, headers, and body sent for each API request (if debug option is enabled).
  • response - The JSON response from the API after adding the Autopilot device.

Dependencies

  • An API key credential for authenticating with the CIPP API

Troubleshooting

  • Ensure the Tenant Filter is correctly specified and corresponds to a valid tenant in the Partner Center.
  • Verify that the Autopilot Data is correctly formatted and includes all required fields for the API.
  • If using Custom Body, ensure the JSON is valid and does not conflict with other fields.
  • Check API authentication credentials and permissions to ensure the request is authorized.
  • Enable Debug option to get detailed request and response information for troubleshooting.

Discussion