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

CIPPExtensions → ExecExtensionTest

AI-generated

Overview

The CIPPExtensions - ExecExtensionTest operation in this node allows users to execute a test API call to the /api/ExecExtensionTest endpoint of the CIPP platform. This operation is useful for verifying the connectivity and functionality of extensions within the CIPP system. It supports optional input properties such as 'Extension Name' to specify the extension to test, and options for custom request body, headers, query filters, batching, debugging, pagination, and timeout settings.

Use Case Examples

  1. Testing an extension by specifying its name to verify its integration and response from the CIPP API.
  2. Running the ExecExtensionTest operation with custom headers and query filters to simulate specific request scenarios for troubleshooting.

Properties

Name Meaning
Return All Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned.
Additional Fields.Extension Name The extension name to test.
Options.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 as {} to skip.
Options.Custom Headers Custom HTTP headers to add to the request.
Options.Query Filters Query-string filters to add to the request URL.
Options.Batching.Batch Settings.Items Per Batch Number of input items grouped per batch; the node makes one request per input item, pausing between batches.
Options.Batching.Batch Settings.Batch Interval (ms) Milliseconds to wait between batches to help avoid rate limiting.
Options.Debug When enabled, includes the actual URL, query parameters, headers, and body sent for each API request in the output under a debug entry for troubleshooting.
Options.Pagination.Pagination Mode How the API handles pagination: offset-based, cursor-based, or response contains next URL.
Options.Pagination.Page Parameter Name (Offset) Offset mode query parameter name for the page number or offset (e.g., page, offset, skip).
Options.Pagination.Start Value (Offset) Offset mode starting value for the page parameter; use 1 for page-based or 0 for offset-based.
Options.Pagination.Increment By (Offset) Offset mode increment for the page parameter per request.
Options.Pagination.Page Size Expected items per page, used to detect the last page.
Options.Pagination.Page Size Parameter Name (Offset) Offset mode query parameter name for page size (e.g., per_page, limit). Leave empty to not send.
Options.Pagination.Cursor Parameter Name (Cursor) Cursor mode query parameter name to send the cursor/token (e.g., cursor, after, page_token).
Options.Pagination.Response Cursor Path (Cursor) Cursor mode dot-notation path to the next cursor in the response (e.g., pagination.next_cursor).
Options.Pagination.Response Next URL Path (URL) URL mode dot-notation path to the next page URL in the response (e.g., pagination.next, @odata.nextLink).
Options.Pagination.Response Data Path Dot-notation path to the array of items in the response (e.g., data, results). Leave empty if the response itself is the array.
Options.Pagination.Max Pages Maximum number of pages to fetch; set to 0 for no limit.
Options.Pagination.Request Interval (ms) Milliseconds to wait between page requests; set to 0 for no delay.
Options.Timeout (ms) Time in milliseconds to wait for the server to send response headers before aborting the request. Default is 300,000 (5 minutes).

Output

JSON

  • debug - Debug information including actual URL, query parameters, headers, and body sent for each API request (if debug option is enabled).
  • json - The JSON response from the /api/ExecExtensionTest API call.

Dependencies

  • An API key credential for authenticating with the CIPP API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access the /api/ExecExtensionTest endpoint.
  • If the request fails, check the debug output (if enabled) to verify the exact request details and response for troubleshooting.
  • Verify that the extension name provided (if any) is valid and exists in the CIPP system.

Links

Discussion