CIPP
Retrieves a list of scheduled items
Whether to show hidden system jobs
Filter by job name
Scheduled items retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ListScheduledItems HTTP/1.1
Host:
Accept: */*
[
{
"ExecutedTime": "text",
"TaskState": "Running",
"Tenant": "text",
"Name": "text",
"ScheduledTime": 1,
"Command": "text",
"Parameters": {},
"PostExecution": "text",
"Recurrence": "text",
"Results": "text",
"RowKey": "text"
}
]Removes a scheduled item
The RowKey of the scheduled item to remove
Scheduled item removed successfully
Bad request
Unauthorized
Internal server error
POST /api/RemoveScheduledItem HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"id": "text"
}{
"Results": {}
}Adds a new scheduled item
Name of the scheduled job
When the job is scheduled to run (Unix timestamp)
How often the job recurs
Parameters for the command
JSON string of parameters for advanced configuration
Unique identifier for the job (for editing existing jobs)
Scheduled item added successfully
Bad request
Unauthorized
Internal server error
POST /api/AddScheduledItem HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 251
{
"tenantFilter": {
"value": "text",
"label": "text"
},
"Name": "text",
"command": {
"label": "text",
"value": "text"
},
"ScheduledTime": 1,
"Recurrence": "0",
"parameters": {},
"RawJsonParameters": "text",
"postExecution": [
{
"label": "text",
"value": "Webhook"
}
],
"RowKey": "text"
}{
"Results": {}
}Retrieves a list of available functions and their parameters
The module to list functions for
Function parameters retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ListFunctionParameters?Module=CIPPCore HTTP/1.1
Host:
Accept: */*
[
{
"Function": "text",
"Synopsis": "text",
"Parameters": [
{
"Name": "text",
"Type": "text",
"Required": true
}
]
}
]Retrieves a list of tenants
Whether to include the 'All Tenants' option
Tenants retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ListTenants HTTP/1.1
Host:
Accept: */*
[
{
"customerId": "text",
"defaultDomainName": "text",
"displayName": "text"
}
]Clears the tenant cache
Whether to clear the cache
Whether to only clear the tenant cache
Cache cleared successfully
Bad request
Unauthorized
Internal server error
POST /api/ListTenants HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ClearCache": true,
"TenantsOnly": true
}{
"Results": {}
}Retrieves the current password configuration
Whether to list the password configuration
Password configuration retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ExecPasswordConfig?list=true HTTP/1.1
Host:
Accept: */*
{
"Results": {
"passwordType": "Classic"
}
}Updates the password configuration
The type of password generation
Password configuration updated successfully
Bad request
Unauthorized
Internal server error
POST /api/ExecPasswordConfig HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"passwordType": "Classic"
}{
"Results": {}
}Retrieves a list of backups
Whether to only return backup names
The name of a specific backup to retrieve
Backups retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ExecListBackup HTTP/1.1
Host:
Accept: */*
[
{
"BackupName": "text",
"Timestamp": "text",
"Backup": "text"
}
]Enables or disables automatic backups
Whether to enable automatic backups
Automatic backup setting updated successfully
Bad request
Unauthorized
Internal server error
POST /api/ExecSetCIPPAutoBackup HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"Enabled": true
}{
"Results": {}
}Restores a backup
The backup data to restore
Backup restored successfully
Bad request
Unauthorized
Internal server error
POST /api/ExecRestoreBackup HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"BackupName": "text"
}{
"Results": {}
}Retrieves a list of logs
Filter logs by date (YYYYMMDD format)
Whether to apply filtering
Logs retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/Listlogs HTTP/1.1
Host:
Accept: */*
[
{
"DateTime": "text",
"Tenant": "text",
"TenantID": "text",
"User": "text",
"Message": "text",
"API": "text",
"Severity": "text",
"AppId": "text",
"IP": "text",
"LogData": "text"
}
]Retrieves the configuration for extensions
Extensions configuration retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ListExtensionsConfig HTTP/1.1
Host:
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": {
"Enabled": true
}
}Updates the configuration for extensions
Extensions configuration updated successfully
Bad request
Unauthorized
Internal server error
POST /api/ExecExtensionsConfig HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"ANY_ADDITIONAL_PROPERTY": {
"Enabled": true
}
}{
"Results": {}
}Tests an extension
The name of the extension to test
Extension test completed successfully
Bad request
Unauthorized
Internal server error
GET /api/ExecExtensionTest?extensionName=text HTTP/1.1
Host:
Accept: */*
{
"Results": {}
}Syncs an extension
The name of the extension to sync
Extension sync completed successfully
Bad request
Unauthorized
Internal server error
GET /api/ExecExtensionSync?Extension=text HTTP/1.1
Host:
Accept: */*
{
"Results": {}
}Retrieves the mapping for an extension
The name of the extension to get mapping for
Extension mapping retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ExecExtensionMapping?List=text HTTP/1.1
Host:
Accept: */*
{
"Mappings": [
{
"TenantId": "text",
"Tenant": "text",
"IntegrationName": "text",
"IntegrationId": "text",
"TenantDomain": "text"
}
],
"Companies": [
{
"name": "text",
"value": "text"
}
]
}Updates the mapping for an extension
The name of the extension to update mapping for
The name of the extension to auto-map
The tenant ID
The tenant name
The integration name
The integration ID
The tenant domain
Extension mapping updated successfully
Bad request
Unauthorized
Internal server error
POST /api/ExecExtensionMapping HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 107
[
{
"TenantId": "text",
"Tenant": "text",
"IntegrationName": "text",
"IntegrationId": "text",
"TenantDomain": "text"
}
]{
"Results": {}
}Retrieves a list of extension sync jobs
Extension sync jobs retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ListExtensionSync HTTP/1.1
Host:
Accept: */*
[
{
"Tenant": "text",
"SyncType": "text",
"Task": "text",
"ScheduledTime": "text",
"ExecutedTime": "text",
"LastRun": "text",
"RepeatsEvery": "text",
"Results": "text"
}
]Retrieves a list of Exchange cmdlets
Exchange cmdlets retrieved successfully
Bad request
Unauthorized
Internal server error
POST /api/ListExoRequest HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"availableCmdlets": true,
"tenantFilter": "text",
"compliance": true,
"asApp": true
}{
"Results": [
{
"Cmdlet": "text"
}
]
}Executes operations on Azure tables
The function to execute
The name of the table
The parameters for the function
Azure table operation executed successfully
Bad request
Unauthorized
Internal server error
POST /api/ExecAzBobbyTables HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"FunctionName": "Get-AzDataTable",
"TableName": "text",
"Parameters": {}
}{
"Results": {}
}Executes a CIPP function
The function to execute
The parameters for the function
CIPP function executed successfully
Bad request
Unauthorized
Internal server error
POST /api/ExecCippFunction HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"FunctionName": "Get-CIPPTimerFunctions",
"Parameters": {}
}{
"Results": {}
}Retrieves information about API clients
The action to perform
API client information retrieved successfully
Bad request
Unauthorized
Internal server error
GET /api/ExecApiClient?Action=GetAzureConfiguration HTTP/1.1
Host:
Accept: */*
{
"Results": {
"Enabled": true,
"ApiUrl": "text",
"TenantID": "text",
"ClientIDs": [
"text"
]
}
}Updates an API client
The action to perform
The action to perform
The client ID
The application name
The client role
The allowed IP ranges
Whether the client is enabled
Whether to remove the app registration
API client updated successfully
Bad request
Unauthorized
Internal server error
POST /api/ExecApiClient HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"Action": "AddUpdate",
"ClientId": "text",
"AppName": "text",
"Role": "text",
"IPRange": [
"text"
],
"Enabled": true,
"RemoveAppReg": true
}{
"Results": {}
}Last updated
Was this helpful?