Skip to main content
Control D logo
  • Category: security & identity tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 54
  • Triggers: 0
  • Slug: CONTROL_D
  • Version: 20261101_00

Tools

Slug: CONTROL_D_DELETE_DEVICES_DEVICE_IDPermanently delete a Control-D device/endpoint by its ID. WARNING: This is a destructive operation. Deleting a device will break DNS resolution on any physical gadget configured to use this device’s unique DNS resolvers. Use GET /devices to retrieve valid device IDs before calling this action.

Input Parameters

string
required
Unique identifier of the device to delete. Use GET /devices to retrieve valid device IDs.
string
Optional header to impersonate a child sub-organization admin (organization accounts only).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_DELETE_PROFILES_PROFILE_IDPermanently deletes a Control D profile by its unique identifier (PK). IMPORTANT: The profile must be orphaned (not enforced by any device) before it can be deleted. If the profile is currently assigned to one or more devices, the deletion will fail. Use this tool when you need to remove an unused profile from the account. To check if a profile is safe to delete, first verify it has no associated devices using the Get Devices or Get Profile endpoints.

Input Parameters

string
required
The unique primary key (PK) of the profile to delete. The profile must be orphaned (not enforced by any device) to be deleted successfully.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_DELETE_PROFILES_PROFILE_ID_RULES_RULE_IDDelete a custom DNS rule from a Control D profile by its rule identifier (hostname/domain). This tool removes a DNS filtering rule from the specified profile. Rules in Control D are identified by the hostname/domain they target (e.g., ‘example.com’, ‘ads.domain.com’). Prerequisites: - Obtain profile_id from GET /profiles endpoint - Obtain rule_id (the hostname/domain) from GET /profiles/{profile_id}/rules endpoint Note: Requires write access to the API (read-only tokens will receive a 403 error).

Input Parameters

string
required
The identifier of the custom rule to delete. In Control D, rules are identified by their hostname/domain (e.g., ‘example.com’, ‘ads.domain.com’, ‘*.example.org’). This is the PK field returned when listing rules.
string
required
Primary key (PK) of the profile from which to delete the rule. Obtain this from the GET /profiles endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_DELETE_PROFILES_PROFILE_ID_RULES_RULE_ID_FOLDER_IDDelete a custom DNS rule from a specific folder in a Control D profile. This action permanently removes a custom rule (e.g., block, bypass, spoof, or redirect) from the specified folder within a profile. Requires valid profile_id, rule_id, and folder_id which can be obtained from: - profile_id: Get Profiles action - folder_id: Get Profile Folders action - rule_id: List Custom Rules in Folder action

Input Parameters

string
required
The unique identifier of the custom rule to delete. Obtain from GET /profiles/{profile_id}/rules/{folder_id} or the List Custom Rules in Folder action.
string
required
The folder (group) identifier containing the rule. Obtain from GET /profiles/{profile_id}/groups or the Get Profile Folders action.
string
required
The profile’s primary key (PK). Obtain from GET /profiles or the Get Profiles action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_DELETE_PROFILES_PROFILE_ID_SCHEDULES_SCHEDULE_IDTool to delete a specific schedule within a profile. Use after confirming profile_id and schedule_id.

Input Parameters

string
required
Unique identifier of the profile from which to delete the schedule
string
required
Unique identifier of the schedule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_ACCESSList up to the latest 50 IP addresses that were used to query against a specific Device (resolver). Use this to retrieve known access IPs associated with a device in your Control D account.

Input Parameters

string
required
Primary key (unique identifier) of the device to retrieve access IPs for. Required parameter.
string
For organization accounts, impersonate a child sub-organization admin to view/modify access IPs within that sub-org.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_ANALYTICS_ENDPOINTSTool to list analytics storage regions and their endpoints. Use after authenticating to retrieve available analytics regions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_ANALYTICS_LEVELSTool to retrieve available analytics log levels for Control D devices. Use when you need to know what analytics options can be configured on devices (No Analytics, Some Analytics, Full Analytics).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_BILLING_PAYMENTSTool to retrieve billing history of all payments made. Use when you need to access payment records, transaction history, or billing information for the account.

Input Parameters

string
Optional organization ID to impersonate a child sub-organization admin. Only applicable for organization accounts with sub-organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_BILLING_PRODUCTSRetrieve all products currently activated on the Control D account. Use this to view active billing products, subscriptions, and their details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_DEVICESLists all Control D devices (endpoints) associated with the account. Each device represents a unique DNS resolver that enforces a Profile (set of filtering rules). Use this to retrieve device inventory, check device status, or get resolver configuration details. Optionally filter by device_type to get only ‘users’ (desktops/mobiles/browsers) or ‘routers’.

Input Parameters

string ("users" | "routers")
Filter devices by type. Use ‘users’ for desktop/mobile/browser devices, ‘routers’ for router devices. Omit to get all devices.
string
Optional organization ID to impersonate a child sub-organization admin. Only applicable for organization accounts with sub-organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_DEVICES_TYPESList all allowed device types in Control D. Returns categorized device types (OS, Browser, TV, Router) with their available icon identifiers and human-readable labels. Use when you need to display device type options or validate device icon identifiers when creating or updating devices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_IPTool to retrieve the current IP address and datacenter information for the API request. Use when you need to check which IP address is being used or which Control D datacenter is handling requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_NETWORKTool to retrieve network stats on available services in different POPs (Points of Presence). Use when you need information about service availability across Control D’s network infrastructure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_ORGANIZATIONS_MEMBERSTool to view organization membership. Use to retrieve a list of all members in the organization including their email, status, permission levels, and last activity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_ORGANIZATIONS_ORGANIZATIONTool to view the authenticated organization’s details. Use after confirming a valid API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_ORGANIZATIONS_SUB_ORGANIZATIONSTool to view sub-organizations and their details. Use when you need to list all sub-organizations under the authenticated organization account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILESTool to list all profiles associated with the authenticated account. Use when you need an overview of accessible profiles.

Input Parameters

string
For organization accounts only; impersonate a child sub-organization admin for all Profiles-scope calls

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_OPTIONSRetrieves all available configuration options for DNS profiles in Control D. Returns a list of profile options including security filters (Safe Search, AI Malware Filter), TTL settings, block responses, and advanced DNS options (DNSSEC, DNS64, CNAME Flattening). Each option includes its type (toggle/dropdown/field), default value, and documentation URL. Use this to discover what settings can be configured when creating or updating profiles.

Input Parameters

string
For organization accounts only; impersonate a child sub-organization admin for all Profiles-scoped calls

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_IDTool to retrieve details of a specific profile by its ID. Use when you need full profile details after confirming the profile_id.

Input Parameters

string
required
Unique identifier of the profile to retrieve
string
For organization accounts only; impersonate a child sub-organization admin to retrieve the profile in that context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICSRetrieve analytics data for a Control D profile. Returns DNS query statistics and traffic data for the specified profile. Use profile_id=‘0’ to get analytics for all profiles, or specify a profile ID from the List Profiles endpoint.

Input Parameters

string
required
Unique identifier (PK) of the profile to fetch analytics for. Use ‘0’ to fetch analytics for all profiles, or a specific profile ID obtained from the List Profiles endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_LOGSRetrieve DNS query activity logs for a Control D profile, optionally filtered by date range or scoped to a child sub-organization. Use the logs to monitor DNS activity, audit policies, or troubleshoot resolution issues.

Input Parameters

string
UTC end timestamp for filtering logs in ISO 8601 format. Logs up to this time will be included. If omitted, defaults to current time.
string
UTC start timestamp for filtering logs in ISO 8601 format. Logs from this time onwards will be included. If omitted, defaults to API’s default range.
string
required
The unique identifier (PK) of the profile to retrieve analytics logs for. Obtain profile IDs from the GET /profiles endpoint.
string
For multi-organization accounts, specify a sub-organization ID to impersonate that organization’s context when retrieving analytics logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_LOGS_LOG_IDTool to retrieve a specific analytics log entry by its ID. Use when you need details of an analytics log for a given profile.

Input Parameters

string
required
Identifier of the analytics log entry to retrieve.
string
required
Identifier of the target profile (Profile PK).
string
For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_SUMMARYTool to fetch a summary of analytics data for a given profile. Use after confirming profile ID and desired date range.

Input Parameters

string
End date for analytics summary in ISO 8601 format, inclusive.
string
Start date for analytics summary in ISO 8601 format, inclusive.
string
required
Identifier of the target profile (Profile PK).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_TOP_DOMAINSTool to fetch top domains accessed within a specific profile. Use after confirming profile ID.

Input Parameters

string
End date for analytics in ISO 8601 format, inclusive.
string
Start date for analytics in ISO 8601 format, inclusive.
string
required
Identifier of the target profile (Profile PK).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_TOP_SERVICESTool to fetch top services accessed within a profile. Use after confirming the profile ID and desired date range.

Input Parameters

string
End date for analytics data in ISO 8601 format, inclusive.
string
Start date for analytics data in ISO 8601 format, inclusive.
string
required
Identifier of the target profile (Profile PK).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_FILTERSList all native (Control D curated) filters for a profile and their current states. Native filters are hand-curated blocklists maintained by Control D (e.g., ‘Ads & Trackers’, ‘Malware’, ‘Adult Content’). Use this to see which filters are enabled/disabled for a profile. For 3rd party community filters, use the GET /profiles/{profile_id}/filters/external endpoint instead.

Input Parameters

string
required
Primary key (PK) of the target profile. Obtain this from the GET /profiles endpoint.
string
For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_FILTERS_EXTERNALTool to list third-party filters for a specific profile. Use when you need to retrieve all external filters and their states after confirming the profile ID.

Input Parameters

string
required
Primary key (PK) of the target profile. Obtain this from the GET /profiles endpoint.
string
For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_FOLDERSList all rule folders (groups) within a Control D profile. Rule folders are used to organize and group custom DNS rules. Each folder has an action type (BLOCK, BYPASS, SPOOF, or REDIRECT) and contains multiple rules. Use this after obtaining a valid profile_id from the list profiles endpoint.

Input Parameters

string
required
Primary key (PK) of the profile. This is an alphanumeric string identifier obtained from the list profiles endpoint.
string
For organization accounts, impersonate a child sub-organization admin for profile-scoped API calls. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_RULESRetrieve custom DNS rules for a Control D profile. Returns rules that control domain resolution (BLOCK, BYPASS, SPOOF, or REDIRECT actions). Omit folder_id to list root folder rules, or provide a folder_id to list rules in a specific folder.

Input Parameters

string
Target folder ID to list rules from. Use ‘0’ or omit entirely for root folder rules. Get folder IDs from GET /profiles/{profile_id}/folders endpoint.
string
required
The profile’s primary key (PK). Obtain this alphanumeric ID from the GET /profiles endpoint.
string
For organization accounts only: impersonate a child sub-organization admin within Profiles scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_RULES_RULE_ID_FOLDER_IDRetrieve a specific custom rule by ID within a Control D profile folder. Use it to inspect the rule, optionally in a child sub-organization’s context.

Input Parameters

string
required
Rule identifier used in the path
string
required
Folder identifier used in the path
string
required
Profile identifier used in the path
string
Optional header to impersonate a child sub-organization within Profiles scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_SCHEDULESTool to list schedules associated with a specific profile. Use after confirming the profile ID.

Input Parameters

string
required
Identifier of the target profile (Profile PK)
string
For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_SCHEDULES_SCHEDULE_IDTool to retrieve a specific schedule by its ID within a profile. Use when you need details of a profile schedule after confirming the profile_id and schedule_id.

Input Parameters

string
required
Identifier of the target profile (Profile PK).
string
required
Identifier of the schedule to retrieve.
string
For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROFILES_PROFILE_ID_SERVICESTool to list services associated with a specific profile. Use when you need to retrieve all services that have any associated rules after confirming the profile ID.

Input Parameters

string
required
Unique identifier (PK) of the target profile. Obtain profile IDs by calling the List Profiles endpoint first.
string
For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_PROXIESTool to retrieve the list of usable proxy locations that traffic can be redirected through. Use when you need to see available proxy exit locations for routing traffic via transparent proxies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_SERVICES_CATEGORIESList all available service categories in Control D. Returns categories like audio, video, social, gaming, etc. Each category contains multiple services that can be blocked or allowed. Use the returned ‘PK’ field as the category identifier when calling other service-related endpoints (e.g., get services by category). No parameters required - returns all available categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_SERVICES_CATEGORIES_CATEGORYRetrieves all services within a specific ControlD service category. Use this to discover available services (like Spotify, Netflix, Steam, etc.) that can be configured for DNS filtering or redirection. Each service includes its unique PK identifier needed for service-level configuration. First call GET /services/categories to get valid category identifiers.

Input Parameters

string
required
Category identifier (PK) to retrieve services from. Valid categories include: audio, career, finance, gaming, hosting, news, recreation, shop, social, tools, vendors, video. Use GET /services/categories to retrieve the full list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_GET_USERSRetrieve the authenticated user’s account information from Control D. This tool returns comprehensive user account data including: - Basic user info (email, status, 2FA settings) - Organization membership and permissions (if applicable) - Account limits and features Use this tool to: - Verify the authenticated account details - Check organization membership and permissions - Get account status and capabilities - Retrieve the user’s PK (primary key) for other API calls No parameters required - uses the authenticated API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_POST_DEVICESCreate a new device (DNS endpoint) in Control D. Each device gets unique DNS resolvers that enforce configured profiles. Requires a valid profile_id from GET_PROFILES. Returns DNS resolver URLs (DoH, DoT) and IPs for configuring client devices.

Input Parameters

string
Optional description or comment for the device.
string
required
Device icon/type. Common values: ‘desktop-windows’, ‘desktop-mac’, ‘desktop-linux’, ‘mobile-android’, ‘mobile-apple’, ‘router’, ‘server’, ‘other’.
string
required
Device name for identification (e.g., ‘John’s iPhone’, ‘Home Router’).
integer ("0" | "1" | "2")
Analytics level: 0=off, 1=basic (query counts), 2=full (includes domains). Default depends on account settings.
integer ("0" | "1")
Enable automatic IP learning: 0=disable, 1=enable. When enabled, the device learns its IP automatically.
string
required
Primary key (PK) of the main profile to enforce on this device. Get from GET_PROFILES action.
integer ("0" | "1")
Restrict device to authorized IPs only: 0=off, 1=on. If enabled, only pre-authorized IPs can use this endpoint.
string
Primary key of a second profile to enforce on this device (optional).
integer ("0" | "1")
Set to 1 to generate legacy IPv4/IPv6 DNS resolvers in addition to the primary resolver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_POST_PROFILESCreate a new blank profile or clone an existing one. Profiles define DNS filtering rules, services, and settings that can be applied to devices. Use this to provision a new profile before assigning rules, filters, or devices to it.

Input Parameters

string
required
Name for the new profile. Must be a non-empty string.
string
For organization accounts only: impersonate a child sub-organization admin for this operation.
string
Primary key of an existing profile to clone. If omitted, a blank profile is created. Get profile IDs using the GET /profiles endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_POST_PROFILES_PROFILE_ID_RULESCreate custom DNS rules for a profile to control domain resolution. Use this to block ads/trackers, bypass filtering for specific domains, spoof DNS responses with custom IPs, or redirect traffic through proxies.

Input Parameters

integer
required
Rule type: 0=BLOCK (block domain), 1=BYPASS (bypass filtering), 2=SPOOF (return custom IP/hostname), 3=REDIRECT (route through proxy).
string
Target for SPOOF (IPv4 address or hostname) or REDIRECT (proxy identifier like ‘JFK’, ‘LAX’). Required when do=2 or do=3.
integer
Folder ID to create the rule in. If omitted, rule is created in the root folder.
integer
Rule status: 1=enabled, 0=disabled. Defaults to enabled.
string
IPv6 address for SPOOF rules (AAAA record). Only used when do=2.
array
required
List of hostnames/domains to apply the rule to. Supports wildcards (e.g., ‘*.example.com’).
string
required
Profile primary key (PK) where rules will be created. Get this from the GET /profiles endpoint.
string
For organization accounts: impersonate a child sub-organization admin within the Profiles scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_POST_PROFILES_PROFILE_ID_RULES_FOLDER_IDTool to create custom rules within a specific folder for a profile. Use after confirming the profile and folder IDs and preparing rule definitions.

Input Parameters

array
required
List of custom rule objects to create. Each rule object must include: ‘do’ (int: 0=BLOCK, 1=BYPASS, 2=SPOOF, 3=REDIRECT), ‘status’ (int: 0=disabled, 1=enabled), ‘hostnames’ (array of domain names). Optional: ‘via’ (spoof target IP/hostname or proxy ID like ‘JFK’), ‘via_v6’ (IPv6 address for SPOOF).
string
required
Numeric folder ID (group PK) where rules will be created. Use ‘0’ for the root folder.
string
required
Profile primary key (PK) where rules will be created
string
For organization accounts: impersonate a child sub-organization admin within the Profiles scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_POST_PROFILES_PROFILE_ID_SCHEDULESCreate a new time-based schedule within a Control D profile. Schedules allow automatic enforcement of profile rules during specified time windows. Use this to set up recurring time periods (e.g., work hours, bedtime) when specific DNS filtering rules should apply. Requires a valid profile_id from GET /profiles.

Input Parameters

object
required
Schedule configuration object. Must include ‘time_start’ and ‘time_end’ in HH:MM format. Optionally specify ‘tz’ for timezone and ‘week’ for active days.
string
required
Profile primary key (PK) where schedule will be created. Obtain this from the GET /profiles endpoint
string
For organization accounts: impersonate a child sub-organization admin within the Profiles scope. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_DEVICES_DEVICE_IDModify an existing Control D device’s settings. Use this tool to update device properties such as name, associated profiles, analytics level, IP learning, restrictions, DDNS settings, and status. At least one field to update must be provided alongside the device_id.

Input Parameters

string
Add a description or comment to the device.
string
New device name.
integer
Analytics level for the device. 0=off, 1=basic, 2=full.
integer
Update device status: 0=pending, 1=active, 2=soft disabled, 3=hard disabled.
integer
Enable/disable experimental ECH support and TLS bumping.
integer
Enable/disable automatic IP learning. 0=disabled, 1=enabled.
string
required
Unique identifier (PK) of the device to modify. Obtain this from the GET /devices endpoint.
string
Primary key of the main profile to enforce on this device.
integer
Make device restricted. 0=disabled, 1=enabled.
integer
Status of public DDNS endpoint. 1=enabled, 0=disabled.
string
Primary key of a second profile to enforce. Use ‘-1’ to remove the secondary profile.
string
DDNS hostname to query to learn new IPs.
string
DDNS subdomain to expose the IP on.
string
Optional header to impersonate a child sub-organization admin. Only applicable for organization accounts managing sub-organizations.
integer
Status of DDNS-based IP learning. 0=disabled, 1=enabled.
integer
Set to 1 to generate legacy IPv4/IPv6 DNS resolver, 0 to remove.
string
ctrld .toml config file content to deploy to the device.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_ORGANIZATIONSModify organization settings such as name, contact details, website, and device limits. Use this to update organization metadata or change billing-related limits (max_users, max_routers). Note: Changing max_users or max_routers is a billable event. Requires a write-enabled API token with organization admin permissions.

Input Parameters

string
Organization display name
string
Physical address of the organization
string
Organization website URL
integer
Maximum number of user devices allowed. Changing this is a billable event.
integer
Whether two-factor authentication is required for all members. 0 = not required, 1 = required.
integer
Maximum number of router devices allowed. Changing this is a billable event.
string
Name of the responsible contact person
string
Primary contact email address for the organization
string
Contact phone number
string
Optional header to impersonate a sub-organization by its ID. Only usable by parent organizations.
string
Global profile ID to enforce on all devices in the organization
string
Storage region primary key for analytics data (e.g., ‘syd-org01’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_PROFILES_PROFILE_IDModify an existing profile by its ID. Use this to update profile properties such as the display name, deactivation timestamp, or lock status. Requires at least one modifiable field (name, disable_ttl, lock_status, lock_message).

Input Parameters

string
New display name for the profile.
string
Account credentials required when unlocking a previously locked profile.
string
required
Profile primary key (PK) identifying the profile to modify.
integer
Unix timestamp until which the profile is deactivated. Set to 0 to remove any prior deactivation.
integer
Controls edit restrictions on the profile. 0 = unlocked, 1 = locked.
string
Custom error message returned when attempting to modify a locked profile.
string
For organization accounts only; impersonate a child sub-organization admin for Profiles-scope calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_PROFILES_PROFILE_ID_FILTERSTool to bulk update filters on a specific profile. Use when you need to enable or disable multiple filters at once. Provide a list of filter IDs with desired states.

Input Parameters

array
required
List of filters to update with desired enabled states
string
required
Identifier of the target profile (Profile PK)
string
For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_PROFILES_PROFILE_ID_FILTERS_EXTERNALTool to update external filters for a specific profile. Use when toggling third-party filters after listing them.

Input Parameters

array
required
List of external filter update objects. Each must include ‘filter_id’ and ‘enabled’ flag.
string
required
Unique identifier of the profile to update
string
For organization accounts, impersonate a child sub-organization admin within the Profiles scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_PROFILES_PROFILE_ID_FILTERS_FILTER_FILTERModify the enabled state of a specific native filter on a profile. Use this tool to enable or disable individual content filters like ‘ads’, ‘malware’, ‘social’, etc. on a specific profile. The filter status is set using integer values (1 = enabled, 0 = disabled).

Input Parameters

string
required
The filter name/ID to enable or disable. Valid native filters include: ‘ads’ (Ads & Trackers), ‘porn’ (Adult Content), ‘fakenews’ (Clickbait), ‘cryptominers’ (Crypto), ‘dating’ (Dating), ‘drugs’ (Drugs), ‘gambling’ (Gambling), ‘gov’ (Government Sites), ‘iot’ (IoT Telemetry), ‘malware’ (Malware), ‘nrd’ (New Domains), ‘typo’ (Phishing), ‘social’ (Social), ‘torrents’ (Torrents), ‘dnsvpn’ (VPN & DNS).
integer
required
Status of the filter: 1 to enable, 0 to disable.
string
required
The profile primary key (PK) to modify filters on. Obtain from GET /profiles.
string
For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_PROFILES_PROFILE_ID_RULESModify an existing custom DNS rule for a profile in Control D. Use this to update rule properties such as action type (block/bypass/spoof/redirect), status (enabled/disabled), target hostnames, and redirect destinations. Rule types: - BLOCK (do=0): Block DNS resolution for the hostnames - BYPASS (do=1): Bypass all filters for the hostnames - SPOOF (do=2): Return custom IP addresses (set via/via_v6) - REDIRECT (do=3): Route traffic through a proxy (set via to proxy ID)

Input Parameters

integer
required
Rule action type: 0=BLOCK, 1=BYPASS, 2=SPOOF, 3=REDIRECT
string
Spoof/Redirect target. For SPOOF (do=2): IPv4 address or hostname. For REDIRECT (do=3): valid proxy identifier
integer
ID of the folder to place the rule in. Omit for root folder
integer
required
Rule status: 0=disabled, 1=enabled
string
For SPOOF rules (do=2): IPv6 address (AAAA record)
array
required
Array of hostnames to apply the rule to (e.g., [‘example.com’, ‘*.example.org’])
string
required
Primary key (PK) of the profile containing the rule
string
For organization accounts: impersonate a child sub-organization admin within the Profiles scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_PROFILES_PROFILE_ID_RULES_RULE_IDTool to update an existing custom rule by its ID. Use when modifying details like name, description, severity, or enabled status for a specific rule.

Input Parameters

string
Updated name of the custom rule
boolean
Updated enabled status of the custom rule
string
required
Unique identifier of the custom rule to update
integer
Updated severity level of the custom rule (e.g., 0=low, 1=medium, 2=high)
string
required
Unique identifier of the profile containing the custom rule
string
Updated description of what the custom rule enforces
string
For organization accounts: impersonate a child sub-organization admin within the Profiles scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_PROFILES_PROFILE_ID_RULES_RULE_ID_FOLDER_IDTool to move a specific custom rule into a different folder. Use after confirming profile_id, rule_id, and folder_id.

Input Parameters

string
required
The identifier of the custom rule to move. In Control D, rules are identified by their hostname/domain (e.g., ‘example.com’, ‘ads.domain.com’, ‘*.example.org’). This is the PK field returned when listing rules.
string
required
Target folder ID to assign the rule. Use ‘root’ to move the rule back to the root level.
string
required
Unique identifier of the profile containing the rule

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_PROFILES_PROFILE_ID_SCHEDULES_SCHEDULE_IDTool to update a specific schedule within a profile. Use when you need to modify schedule details after confirming profile_id and schedule_id.

Input Parameters

object
required
JSON object containing the schedule fields and values to update.
string
required
Identifier of the target profile (Profile PK).
string
required
Identifier of the schedule to update.
string
For organization accounts, impersonate a child sub-organization admin for profile-scope API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTROL_D_PUT_PROFILES_PROFILE_ID_SERVICES_SERVICETool to modify a specific service rule for a profile. Use when you need to update blocking, bypassing, spoofing, or proxy-redirect settings after reviewing existing rules.

Input Parameters

integer ("0" | "1" | "2" | "3")
required
Rule action type: 0=BLOCK (block service domains), 1=BYPASS (allow domains, overrides filters), 2=SPOOF (redirect domains to custom IP via ‘via’ param), 3=REDIRECT (route traffic through proxy location via ‘via’ param)
string
Required when do=2 (SPOOF): IPv4 address or hostname for A record. Required when do=3 (REDIRECT): 3-letter IATA proxy location code (e.g., ‘YYZ’, ‘LAX’, ‘LHR’). Ignored for do=0/1.
integer ("0" | "1")
required
Rule status: 0=disabled; 1=enabled
string
IPv6 address for AAAA record when do=2 (SPOOF). Ignored for other modes.
string
required
Service PK identifier to modify. Common services include streaming (netflix, youtube, spotify, twitch), social (facebook, twitter, instagram, tiktok), gaming (steam, xbox, playstation), and more. Use GET /services/categories/{category} to discover available service PKs.
string
required
Profile PK (primary key) to update. Obtain from GET /profiles endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not