NAiOS IconNAiOS Logo
Volver al catálogo

Control D

control_d

Control D is a customizable DNS filtering and traffic redirection platform that allows users to manage internet access, enforce policies, and monitor usage across devices and networks.

Acciones
48
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (48)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Delete Device by IDCONTROL_D_DELETE_DEVICES_DEVICE_IDAcción

Tool to delete a Control-D device. Use when you need to remove a device by its identifier after confirming the device_id.

Parámetros de entrada

  • device_idstringObligatorio

    Unique identifier of the device to delete

  • x_force_org_idstring

    Optional X-Force-Org-Id header to impersonate a child sub-organization admin (organization accounts only).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Profile by IDCONTROL_D_DELETE_PROFILES_PROFILE_IDAcción

Tool to delete a profile. Use when you need to remove a profile by its ID after ensuring it is not enforced by any device.

Parámetros de entrada

  • profile_idstringObligatorio

    Profile primary key (PK). Example: '123abc'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Profile Rule by HostnameCONTROL_D_DELETE_PROFILES_PROFILE_ID_RULES_HOSTNAMEAcción

Tool to delete a specific custom rule by hostname from a profile. Use after confirming profile_id and hostname.

Parámetros de entrada

  • hostnamestringObligatorio

    The hostname of the custom rule to delete

  • profile_idstringObligatorio

    Unique identifier of the profile from which to delete the rule

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Profile Rule by Rule IDCONTROL_D_DELETE_PROFILES_PROFILE_ID_RULES_RULE_IDAcción

Tool to delete a specific custom rule by its ID within a profile. Use after confirming profile_id and rule_id.

Parámetros de entrada

  • rule_idstringObligatorio

    The identifier of the custom rule to delete

  • profile_idstringObligatorio

    Unique identifier of the profile from which to delete the rule

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Profile Rule in FolderCONTROL_D_DELETE_PROFILES_PROFILE_ID_RULES_RULE_ID_FOLDER_IDAcción

Tool to delete a specific custom rule within a folder. Use after confirming profile_id, rule_id, and folder_id.

Parámetros de entrada

  • rule_idstringObligatorio

    Unique identifier of the custom rule to delete

  • folder_idstringObligatorio

    Unique identifier of the folder containing the rule

  • profile_idstringObligatorio

    Unique identifier of the profile from which to delete the rule

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Profile ScheduleCONTROL_D_DELETE_PROFILES_PROFILE_ID_SCHEDULES_SCHEDULE_IDAcción

Tool to delete a specific schedule within a profile. Use after confirming profile_id and schedule_id.

Parámetros de entrada

  • profile_idstringObligatorio

    Unique identifier of the profile from which to delete the schedule

  • schedule_idstringObligatorio

    Unique identifier of the schedule to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Known Access IPsCONTROL_D_GET_ACCESSAcción

Tool to list known IPs associated with the account. Use when you need to retrieve recent access IPs for device resolver queries.

Parámetros de entrada

  • device_idstring

    Unique identifier of the device whose access IPs should be listed.

  • X-Force-Org-Idstring

    For organization accounts, impersonate a child sub-organization admin to view/modify access IPs within that sub-org.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Analytics EndpointsCONTROL_D_GET_ANALYTICS_ENDPOINTSAcción

Tool to list analytics storage regions and their endpoints. Use after authenticating to retrieve available analytics regions.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get DevicesCONTROL_D_GET_DEVICESAcción

Tool to list all devices associated with the account. Use when you need to retrieve device inventory after authentication.

Parámetros de entrada

  • device_typestringenum

    Optional path filter: 'users' for user devices, 'routers' for router devices.

    usersrouters
  • x_force_org_idstring

    Optional X-Force-Org-Id header to impersonate a child sub-organization admin (organization accounts only).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Organization DetailsCONTROL_D_GET_ORGANIZATIONS_ORGANIZATIONAcción

Tool to view the authenticated organization's details. Use after confirming a valid API token.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ProfilesCONTROL_D_GET_PROFILESAcción

Tool to list all profiles associated with the authenticated account. Use when you need an overview of accessible profiles.

Parámetros de entrada

  • X-Force-Org-Idstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile OptionsCONTROL_D_GET_PROFILES_OPTIONSAcción

Tool to get all available profile options. Use when you need to retrieve the possible configurations for profiles after authenticating.

Parámetros de entrada

  • X-Force-Org-Idstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile by IDCONTROL_D_GET_PROFILES_PROFILE_IDAcción

Tool to retrieve details of a specific profile by its ID. Use when you need full profile details after confirming the profile_id.

Parámetros de entrada

  • profile_idstringObligatorio

    Unique identifier of the profile to retrieve

  • X-Force-Org-Idstring

    For organization accounts only; impersonate a child sub-organization admin to retrieve the profile in that context.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile AnalyticsCONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICSAcción

Tool to retrieve analytics data for a specific profile. Use after the profile has accrued usage data to fetch analytics.

Parámetros de entrada

  • profile_idstringObligatorio

    Unique identifier of the profile to fetch analytics for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile Analytics LogsCONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_LOGSAcción

Tool to list analytics log entries for a given profile. Use after confirming profile ID and optional date filters to fetch logs.

Parámetros de entrada

  • to_datestring

    UTC end timestamp for filtering logs (ISO 8601).

  • from_datestring

    UTC start timestamp for filtering logs (ISO 8601).

  • profile_idstringObligatorio

    Unique identifier of the profile to list analytics logs for.

  • X-Force-Org-Idstring

    Optional override of organization context for multi-org accounts.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Analytics Log EntryCONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_LOGS_LOG_IDAcción

Tool to retrieve a specific analytics log entry by its ID. Use when you need details of an analytics log for a given profile.

Parámetros de entrada

  • log_idstringObligatorio

    Identifier of the analytics log entry to retrieve.

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK).

  • X-Force-Org-Idstring

    For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile Analytics SummaryCONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_SUMMARYAcción

Tool to fetch a summary of analytics data for a given profile. Use after confirming profile ID and desired date range.

Parámetros de entrada

  • to_datestring

    End date for analytics summary in ISO 8601 format, inclusive.

  • from_datestring

    Start date for analytics summary in ISO 8601 format, inclusive.

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile Analytics Top DomainsCONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_TOP_DOMAINSAcción

Tool to fetch top domains accessed within a specific profile. Use after confirming profile ID.

Parámetros de entrada

  • to_datestring

    End date for analytics in ISO 8601 format, inclusive.

  • from_datestring

    Start date for analytics in ISO 8601 format, inclusive.

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile Top ServicesCONTROL_D_GET_PROFILES_PROFILE_ID_ANALYTICS_TOP_SERVICESAcción

Tool to fetch top services accessed within a profile. Use after confirming the profile ID and desired date range.

Parámetros de entrada

  • to_datestring

    End date for analytics data in ISO 8601 format, inclusive.

  • from_datestring

    Start date for analytics data in ISO 8601 format, inclusive.

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile FiltersCONTROL_D_GET_PROFILES_PROFILE_ID_FILTERSAcción

Tool to list native filters associated with a specific profile. Use when you have a profile ID and need to retrieve its filters and their states.

Parámetros de entrada

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK)

  • X-Force-Org-Idstring

    For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List External Filters for ProfileCONTROL_D_GET_PROFILES_PROFILE_ID_FILTERS_EXTERNALAcción

Tool 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.

Parámetros de entrada

  • profile_idstringObligatorio

    The profile's ID used in the path

  • X-Force-Org-Idstring

    For organization accounts, impersonate a child sub-organization admin within Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile FoldersCONTROL_D_GET_PROFILES_PROFILE_ID_FOLDERSAcción

Tool to list rule folders (groups) within a profile. Use when you need to retrieve all folders for a given profile after confirming the profile ID.

Parámetros de entrada

  • profile_idstringObligatorio

    Identifier of the target profile

  • x_force_org_idstring

    For organization accounts, impersonate a child sub-organization admin for profile-scoped API calls. Optional.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Custom Rules for ProfileCONTROL_D_GET_PROFILES_PROFILE_ID_RULESAcción

Tool to retrieve custom rules associated with a specific profile. Use after confirming the profile ID. Omit `folder_id` to list rules in the root folder.

Parámetros de entrada

  • folder_idstring

    Target folder ID; if provided, lists rules from that folder; omit for root rules

  • profile_idstringObligatorio

    The profile's ID used in the path

  • X-Force-Org-Idstring

    For organization accounts, impersonate a child sub-organization admin within Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Custom Rules in FolderCONTROL_D_GET_PROFILES_PROFILE_ID_RULES_FOLDER_IDAcción

Tool to retrieve custom rules in a specific folder of a profile. Use after confirming both profile ID and folder ID.

Parámetros de entrada

  • folder_idstringObligatorio

    The folder ID used in the path

  • profile_idstringObligatorio

    The profile's ID used in the path

  • X-Force-Org-Idstring

    For organization accounts, impersonate a child sub-organization admin within Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Custom Rule by Rule IDCONTROL_D_GET_PROFILES_PROFILE_ID_RULES_RULE_IDAcción

Tool to retrieve details of a specific custom rule by its ID. Use after confirming the profile_id and rule_id to fetch that rule's metadata.

Parámetros de entrada

  • rule_idstringObligatorio

    Unique identifier of the custom rule to retrieve

  • profile_idstringObligatorio

    Unique identifier of the profile to which the custom rule belongs

  • X-Force-Org-Idstring

    For organization accounts: impersonate a child sub-organization admin within the Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Specific Rule in FolderCONTROL_D_GET_PROFILES_PROFILE_ID_RULES_RULE_ID_FOLDER_IDAcción

Tool to retrieve a specific rule within a folder by its ID. Use when you need full details of a custom rule in a profile's folder.

Parámetros de entrada

  • rule_idstringObligatorio

    Rule identifier used in the path

  • folder_idstringObligatorio

    Folder identifier used in the path

  • profile_idstringObligatorio

    Profile identifier used in the path

  • X-Force-Org-Idstring

    Optional header to impersonate a child sub-organization within Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile SchedulesCONTROL_D_GET_PROFILES_PROFILE_ID_SCHEDULESAcción

Tool to list schedules associated with a specific profile. Use after confirming the profile ID.

Parámetros de entrada

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK)

  • x_force_org_idstring

    For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile ScheduleCONTROL_D_GET_PROFILES_PROFILE_ID_SCHEDULES_SCHEDULE_IDAcción

Tool 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.

Parámetros de entrada

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK).

  • schedule_idstringObligatorio

    Identifier of the schedule to retrieve.

  • X-Force-Org-Idstring

    For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Profile ServicesCONTROL_D_GET_PROFILES_PROFILE_ID_SERVICESAcción

Tool 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.

Parámetros de entrada

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK).

  • x_force_org_idstring

    For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Service CategoriesCONTROL_D_GET_SERVICES_CATEGORIESAcción

Tool to list all service categories. Use when you need to retrieve available categories before filtering or assigning services.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Services by CategoryCONTROL_D_GET_SERVICES_CATEGORIES_CATEGORYAcción

Tool to list all services within a specific category. Use after confirming a valid category identifier.

Parámetros de entrada

  • categorystringObligatorio

    Identifier of the service category to list services from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get UsersCONTROL_D_GET_USERSAcción

Tool to retrieve user account data. Use when you need account details after authentication.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create DeviceCONTROL_D_POST_DEVICESAcción

Tool to create a new device. Use when you need to provision devices and retrieve their DNS resolvers.

Parámetros de entrada

  • bodyobjectObligatorio

    JSON object containing device properties for creation. Refer to API docs for required fields.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ProfileCONTROL_D_POST_PROFILESAcción

Tool to create a new blank profile or clone an existing one. Use when you need to provision a profile before assigning rules or devices.

Parámetros de entrada

  • profileobjectObligatorio

    JSON object representing new profile settings. Schema is undocumented; common keys include 'name' and 'clone_from_pk'.

  • X-Force-Org-Idstring

    Optional org ID to impersonate a child sub-organization admin for Profiles operations.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Custom Rules for ProfileCONTROL_D_POST_PROFILES_PROFILE_ID_RULESAcción

Tool to create custom rules for a profile. Use after confirming the profile ID and preparing rule definitions. Provide a list of rule objects matching the API schema.

Parámetros de entrada

  • rulesobject[]Obligatorio

    List of custom rule objects to create. Each object should follow the API schema, e.g., include 'name', 'description', 'severity', 'enabled', etc. Refer to the API docs.

  • profile_idstringObligatorio

    Profile primary key (PK) where rules will be created

  • X-Force-Org-Idstring

    For organization accounts: impersonate a child sub-organization admin within the Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Custom Rules in Profile FolderCONTROL_D_POST_PROFILES_PROFILE_ID_RULES_FOLDER_IDAcción

Tool to create custom rules within a specific folder for a profile. Use after confirming the profile and folder IDs and preparing rule definitions.

Parámetros de entrada

  • rulesobject[]Obligatorio

    List of custom rule objects to create. Each object should follow the API schema, e.g., include 'name', 'description', 'severity', 'enabled', etc. Refer to the API docs.

  • folder_idstringObligatorio

    Folder identifier within the profile where rules will be created

  • profile_idstringObligatorio

    Profile primary key (PK) where rules will be created

  • X-Force-Org-Idstring

    For organization accounts: impersonate a child sub-organization admin within the Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Profile ScheduleCONTROL_D_POST_PROFILES_PROFILE_ID_SCHEDULESAcción

Tool to create a new schedule within a specific profile. Use after gathering profile_id and schedule details.

Parámetros de entrada

  • scheduleobjectObligatorio

    Schedule object to create. Must follow the API schema, e.g., include 'name', 'start_time', 'recurrence', 'timezone', etc.

  • profile_idstringObligatorio

    Profile primary key (PK) where schedule will be created

  • X-Force-Org-Idstring

    For organization accounts: impersonate a child sub-organization admin within the Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Modify DeviceCONTROL_D_PUT_DEVICES_DEVICE_IDAcción

Tool to modify an existing device. Use when you need to update device settings by providing its ID.

Parámetros de entrada

  • bodyobjectObligatorio

    JSON object containing device fields to update. Refer to API docs for supported properties.

  • device_idstringObligatorio

    Unique identifier of the device to modify.

  • x_force_org_idstring

    Optional X-Force-Org-Id header to impersonate a child sub-organization admin (organization accounts only).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Modify OrganizationCONTROL_D_PUT_ORGANIZATIONSAcción

Tool to modify organization settings and limits. Use when you need to change organization limits such as max_users or max_routers. Changing these fields is a billable event.

Parámetros de entrada

  • max_usersinteger

    Maximum number of users allowed; changing this is a billable event

  • max_routersinteger

    Maximum number of routers allowed; changing this is a billable event

  • X-Force-Org-Idstring

    Optional header to impersonate a sub-organization by its ID

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Profile by IDCONTROL_D_PUT_PROFILES_PROFILE_IDAcción

Tool to modify an existing profile by ID. Use when you need to update profile fields after confirming the current profile. Example: Update profile '123abc' with new name and settings.

Parámetros de entrada

  • profileobjectObligatorio

    JSON object containing the profile fields and values to update.

  • profile_idstringObligatorio

    Profile primary key (PK). Example: '123abc'.

  • X-Force-Org-Idstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Bulk Update Profile FiltersCONTROL_D_PUT_PROFILES_PROFILE_ID_FILTERSAcción

Tool 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.

Parámetros de entrada

  • filtersobject[]Obligatorio

    List of filters to update with desired enabled states

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK)

  • x_force_org_idstring

    For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update External Filters for ProfileCONTROL_D_PUT_PROFILES_PROFILE_ID_FILTERS_EXTERNALAcción

Tool to update external filters for a specific profile. Use when toggling third-party filters after listing them.

Parámetros de entrada

  • filtersobject[]Obligatorio

    List of external filter update objects. Each must include 'filter_id' and 'enabled' flag.

  • profile_idstringObligatorio

    Unique identifier of the profile to update

  • X-Force-Org-Idstring

    For organization accounts, impersonate a child sub-organization admin within the Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Modify Profile FilterCONTROL_D_PUT_PROFILES_PROFILE_ID_FILTERS_FILTER_FILTERAcción

Tool to modify the enabled state of a specific filter on a profile. Use when you need to enable or disable a particular filter.

Parámetros de entrada

  • filterstringObligatorio

    Identifier of the filter to modify

  • enabledbooleanObligatorio

    Whether to enable (true) or disable (false) the filter

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK)

  • x_force_org_idstring

    For organization accounts, impersonate a child sub-organization admin for profiles-scope API calls. Optional.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Modify Custom Rules for ProfileCONTROL_D_PUT_PROFILES_PROFILE_ID_RULESAcción

Tool to modify existing custom rule(s) for a profile. Use when you need to update rule details such as name, description, severity, or enabled status. Ensure to include the rule IDs to modify.

Parámetros de entrada

  • rulesobject[]Obligatorio

    List of custom rule updates for the profile

  • profile_idstringObligatorio

    Unique identifier of the profile to update

  • X-Force-Org-Idstring

    Optional: Impersonate a child sub-organization admin for Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Custom Rule by Rule IDCONTROL_D_PUT_PROFILES_PROFILE_ID_RULES_RULE_IDAcción

Tool to update an existing custom rule by its ID. Use when modifying details like name, description, severity, or enabled status for a specific rule.

Parámetros de entrada

  • namestring

    Updated name of the custom rule

  • enabledboolean

    Updated enabled status of the custom rule

  • rule_idstringObligatorio

    Unique identifier of the custom rule to update

  • severityinteger

    Updated severity level of the custom rule (e.g., 0=low, 1=medium, 2=high)

  • profile_idstringObligatorio

    Unique identifier of the profile containing the custom rule

  • descriptionstring

    Updated description of what the custom rule enforces

  • X-Force-Org-Idstring

    For organization accounts: impersonate a child sub-organization admin within the Profiles scope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Move Profile Rule to FolderCONTROL_D_PUT_PROFILES_PROFILE_ID_RULES_RULE_ID_FOLDER_IDAcción

Tool to move a specific custom rule into a different folder. Use after confirming profile_id, rule_id, and folder_id.

Parámetros de entrada

  • rule_idstringObligatorio

    Unique identifier of the custom rule to move

  • folder_idstringObligatorio

    Target folder ID to assign the rule. Use 'root' to move the rule back to the root level.

  • profile_idstringObligatorio

    Unique identifier of the profile containing the rule

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Profile ScheduleCONTROL_D_PUT_PROFILES_PROFILE_ID_SCHEDULES_SCHEDULE_IDAcción

Tool to update a specific schedule within a profile. Use when you need to modify schedule details after confirming profile_id and schedule_id.

Parámetros de entrada

  • scheduleobjectObligatorio

    JSON object containing the schedule fields and values to update.

  • profile_idstringObligatorio

    Identifier of the target profile (Profile PK).

  • schedule_idstringObligatorio

    Identifier of the schedule to update.

  • X-Force-Org-Idstring

    For organization accounts, impersonate a child sub-organization admin for profile-scope API calls.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Modify Service for ProfileCONTROL_D_PUT_PROFILES_PROFILE_ID_SERVICES_SERVICEAcción

Tool 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.

Parámetros de entrada

  • dointegerObligatorioenum

    Action to apply for service domains: 0=Block; 1=Bypass; 2=Spoof domains to IP; 3=Redirect domains via proxy

    0123
  • viastring

    When do=2, supplies the A record or CNAME; when do=3, supplies a 3-letter IATA proxy code

  • statusintegerObligatorioenum

    Rule status: 0=disabled; 1=enabled

    01
  • via_v6string

    When do=2, supplies the AAAA record; ignored otherwise

  • servicestringObligatorio

    Identifier of the service to modify (e.g., 'http', 'ssh')

  • profile_idstringObligatorio

    Unique identifier of the profile to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not