> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Control D

The Control D connector lets your AI agent act in each user's Control D account. Each user connects their own Control D access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 46 tools.

**Authentication:** Bearer Token
**Categories:** Developer Tools, Monitoring
**Tools:** 46: 22 read, 17 write, 7 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CONTROLD)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Control D connection

   In **AgentKit > Connections**, create a Control D connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'controld'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Control D:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'controld_account_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "controld"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Control D:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="controld_account_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Control D credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'controld_account_get',
  toolInput: {},
  connector: 'controld',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="controld_account_get",
    tool_input={},
    connection_name="controld",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `controld_account_get`

Get Account · Read-only

Get the Control D account the API token belongs to.
Returns the user's ID, email, plan, status and settings.
Run it first to confirm the connection.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_analytics_levels_list`

List Analytics Levels · Read-only

List the analytics (logging) levels an endpoint can use.
Returns each level's ID and title.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_analytics_regions_list`

List Analytics Storage Regions · Read-only

List the storage regions for analytics logs.
Returns each region's ID (PK), title and country.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_device_ips_list`

List Endpoint IPs · Read-only

List the IP addresses learned or authorized for an endpoint.
Returns each IP with its location, ISP and last-seen time.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `device_id` (`string`, required): ID (PK) of the endpoint (device or resolver). Get it from controld_devices_list. Example: abcd1234efgh.

Example input: `{"device_id":"<device_id>"}`

### `controld_device_types_list`

List Endpoint Types · Read-only

List endpoint types and icons, such as desktop-windows, mobile-ios or router.
Returns each type's icon ID and name.
Use the icon IDs with controld_device_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_devices_list`

List Endpoints · Read-only

List endpoints (devices and resolvers) in the account.
Returns each endpoint's ID, name, type, status, profiles, DNS resolver addresses and settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_internal_domains_list`

List Internal Domains · Read-only

List internal domain entries, which send matching queries to your own resolvers or the OS resolver.
Returns each entry's ID, domain, mode, resolvers and comment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `x_force_org_id` (`string`, optional): Sub-organization ID to act in, for parent organization accounts. Example: org_12345.

Example input: `{}`

### `controld_ip_get`

Get Caller IP · Read-only

Get the public IP address and data center the API sees for the caller.
Returns the IP, its type and the Control D PoP that answered.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_network_stats_get`

Get Network Status · Read-only

Get the status of Control D's network locations (PoPs) and services.
Returns each location with its status.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_profile_default_rule_get`

Get Default Rule · Read-only

Get a profile's default rule: what happens to queries no other rule matches.
Returns the default action and target.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"profile_id":"<profile_id>"}`

### `controld_profile_external_filters_list`

List Third-Party Filters · Read-only

List third-party block lists (such as OISD or Hagezi) with their status on a profile.
Returns each filter's ID, name and enabled status.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"profile_id":"<profile_id>"}`

### `controld_profile_filters_list`

List Profile Filters · Read-only

List Control D's native blocking filters (ads, malware, adult, social and so on) with their status on a profile.
Returns each filter's ID, name, levels and enabled status.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"profile_id":"<profile_id>"}`

### `controld_profile_folders_list`

List Rule Folders · Read-only

List the custom rule folders on a profile.
Returns each folder's ID, name, action and rule count.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"profile_id":"<profile_id>"}`

### `controld_profile_options_list`

List Profile Options · Read-only

List the profile options that can be set, such as AI malware filter, safe search or TTLs.
Returns each option's name (PK), title, type and allowed values.
Use the names with controld_profile_option_set.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_profile_restrictions_list`

List Profile Restrictions · Read-only

List the restrictions enabled on a profile.
Returns each enabled restriction.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"profile_id":"<profile_id>"}`

### `controld_profile_rules_list`

List Custom Rules · Read-only

List the custom hostname rules in a folder of a profile (0 for the root folder).
Returns each rule's hostname, action, target, status and comment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `folder_id` (`string`, required): Folder ID; 0 for rules outside any folder. Example: 0.
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"folder_id":"<folder_id>","profile_id":"<profile_id>"}`

### `controld_profile_services_list`

List Profile Services · Read-only

List the service rules set on a profile.
Returns each service with its action (block, bypass, spoof, redirect) and status.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"profile_id":"<profile_id>"}`

### `controld_profiles_list`

List Profiles · Read-only

List DNS filtering profiles in the account.
Returns each profile's ID (PK), name, last update and counts of enabled filters, services, rules and folders.
Use the ID with the other profile tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_proxies_list`

List Proxy Locations · Read-only

List the proxy locations traffic can be redirected through.
Returns each location's ID (PK), city, country and gps.
Use the IDs as via when do is 3 (REDIRECT).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_restrictions_list`

List Available Restrictions · Read-only

List the restrictions that can be enabled on a profile.
Returns each restriction's ID (PK) and name.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_service_categories_list`

List Service Categories · Read-only

List the categories of services (apps and websites) Control D can block, bypass or redirect.
Returns each category's ID and name.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `controld_services_list`

List Services in Category · Read-only

List the services in a category, such as social or gaming.
Returns each service's ID (PK), name and category.
Use the IDs with controld_profile_service_set.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category` (`string`, required): Category ID. Get it from controld_service_categories_list. Example: social.

Example input: `{"category":"<category>"}`

### `controld_device_create`

Create Endpoint · Write

Create an endpoint (device or resolver) that uses a profile.
Returns the new endpoint with its ID and DNS resolver addresses (DoH, DoT, IPv4/IPv6).

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `client_count` (`string`, required): Number of devices using this endpoint. Example: 10.
- `icon` (`string`, required): Endpoint type icon, such as desktop-windows. Get it from controld_device_types_list. Example: router.
- `name` (`string`, required): Device name. Example: Office router.
- `profile_id` (`string`, required): ID of the main profile to enforce. Get it from controld_profiles_list. Example: 123456abcdef.
- `desc` (`string`, optional): Description of the endpoint. Example: Main office.
- `learn_ip` (`integer`, optional): 1 to learn and log source IPs automatically. Example: 1.
- `legacy_ipv4_status` (`integer`, optional): 1 to also create a legacy IPv4/IPv6 resolver. Example: 0.
- `profile_id2` (`string`, optional): ID of a second profile to enforce. Example: 654321fedcba.
- `restricted` (`integer`, optional): 1 to allow only learned or authorized IPs. Example: 0.
- `stats` (`integer`, optional): Analytics level: 0 off, 1 basic, 2 full. Example: 1.

Example input: `{"client_count":"<client_count>","icon":"<icon>","name":"<name>","profile_id":"<profile_id>"}`

### `controld_device_ips_add`

Authorize Endpoint IPs · Write

Authorize one or more IP addresses for a restricted endpoint.
Returns a success response.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `device_id` (`string`, required): ID (PK) of the endpoint (device or resolver). Get it from controld_devices_list. Example: abcd1234efgh.
- `ips` (`array`, required): IPv4 or IPv6 addresses to authorize. Example: ["203.0.113.7"].

Example input: `{"device_id":"<device_id>","ips":["203.0.113.7"]}`

### `controld_device_update`

Update Endpoint · Write

Rename an endpoint, change its profiles, analytics, IP learning, restriction or status.
Returns the updated endpoint.
Only the fields you pass change.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `device_id` (`string`, required): ID (PK) of the endpoint (device or resolver). Get it from controld_devices_list. Example: abcd1234efgh.
- `client_count` (`string`, optional): Number of devices using this Endpoint. Example: 10.
- `desc` (`string`, optional): Add a description or comment to the device. Example: Main office.
- `learn_ip` (`integer`, optional): 1 to learn source IPs automatically, 0 to stop. Example: 1.
- `legacy_ipv4_status` (`integer`, optional): Set this to 1 to generate a legacy IPv4 (and IPv6) DNS resolver, 0 to remove existing one. Example: 0.
- `name` (`string`, optional): New Device name. Example: Office router.
- `profile_id` (`string`, optional): ID of the main profile to enforce. Example: 123456abcdef.
- `profile_id2` (`string`, optional): ID of a second profile to enforce; -1 to remove it. Example: -1.
- `restricted` (`integer`, optional): 1 to allow only learned or authorized IPs, 0 to allow all. Example: 0.
- `stats` (`integer`, optional): Analytics level: 0 off, 1 basic, 2 full. Example: 1.
- `status` (`integer`, optional): Endpoint status: 0 pending, 1 active, 2 soft disabled, 3 hard disabled. Example: 1. One of: `0`, `1`, `2`, `3`.

Example input: `{"device_id":"<device_id>"}`

### `controld_internal_domain_create`

Create Internal Domain · Write

Add an internal domain suffix that resolves through your own resolvers or the device's OS resolver.
Returns the new entry.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `domain` (`string`, required): Domain suffix, such as `corp.example.com`. No scheme, path, port, wildcard or IP address. Use punycode for internationalized names. Example: corp.example.com.
- `comment` (`string`, optional): Description of the entry. Example: Office AD domain.
- `mode` (`string`, optional): (Optional) `os` requires `resolvers` to be empty or omitted. `resolvers` requires at least one address. If omitted, the mode follows `resolvers`. Example: resolvers. One of: `os`, `resolvers`.
- `resolvers` (`array`, optional): (Optional) Up to 4 unicast IPv4/IPv6 resolver addresses, in the order they are used. Private addresses are allowed. Omit or send an empty array to use the Endpoint's network or VPN DNS. Example: ["10.0.0.53"].
- `x_force_org_id` (`string`, optional): Sub-organization ID to act in, for parent organization accounts. Example: org_12345.

Example input: `{"domain":"<domain>"}`

### `controld_internal_domain_update`

Update Internal Domain · Write

Change an internal domain entry's domain, resolvers, mode or comment.
Returns the updated entry.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `entry_id` (`string`, required): ID of the entry. Get it from controld_internal_domains_list. Example: 42.
- `comment` (`string`, optional): Description of the entry. Example: Office AD domain.
- `domain` (`string`, optional): Domain suffix, such as `corp.example.com`. No scheme, path, port, wildcard or IP address. Use punycode for internationalized names. Example: corp.example.com.
- `mode` (`string`, optional): (Optional) `os` clears the resolver list. `resolvers` keeps the stored list unless you also send `resolvers`. `os` together with a non-empty `resolvers` is rejected. Example: resolvers. One of: `os`, `resolvers`.
- `resolvers` (`array`, optional): (Optional) Replaces the resolver list. An empty array or null switches the entry to the Endpoint's network or VPN DNS. Example: ["10.0.0.53"].
- `x_force_org_id` (`string`, optional): Sub-organization ID to act in, for parent organization accounts. Example: org_12345.

Example input: `{"entry_id":"<entry_id>"}`

### `controld_profile_create`

Create Profile · Write

Create a DNS filtering profile, blank or cloned from another profile.
Returns the new profile with its ID.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the profile. Example: Kids devices.
- `clone_profile_id` (`string`, optional): ID of a profile to copy settings from; leave empty for a blank profile. Example: 123456abcdef.

Example input: `{"name":"<name>"}`

### `controld_profile_default_rule_set`

Set Default Rule · Write

Set a profile's default rule for queries no other rule matches, such as bypass or redirect through a proxy.
Returns the updated default rule.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `do` (`integer`, required): Rule action: 0 BLOCK, 1 BYPASS, 2 SPOOF (answer with via), 3 REDIRECT (through the proxy location in via). Example: 0. One of: `0`, `1`, `2`, `3`.
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `status` (`integer`, required): 1 to enable the default rule, 0 to disable it. Example: 1. One of: `0`, `1`.
- `via` (`string`, optional): Target for SPOOF (an IPv4 address or hostname) or REDIRECT (a proxy location ID from controld_proxies_list). Example: 203.0.113.10.

Example input: `{"do":0,"profile_id":"<profile_id>","status":1}`

### `controld_profile_filter_set`

Set Profile Filter · Write

Enable or disable one native or third-party filter on a profile.
Returns the updated filter.
Use controld_profile_filters_batch_set to change several at once.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, required): Filter ID, such as ads or malware. Get it from controld_profile_filters_list. Example: ads.
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `status` (`integer`, required): 1 to enable the filter, 0 to disable it. Example: 1. One of: `0`, `1`.

Example input: `{"filter":"<filter>","profile_id":"<profile_id>","status":1}`

### `controld_profile_filters_batch_set`

Set Profile Filters in Bulk · Write

Enable or disable several filters on a profile in one call.
Returns the updated filters.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filters` (`array`, required): Filters to change: each has filter (the ID) and status (1 on, 0 off). Example: [{"filter": "ads", "status": 1}, {"filter": "social", "status": 0}].
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"filters":[{"filter":"ads","status":1},{"filter":"social","status":0}],"profile_id":"<profile_id>"}`

### `controld_profile_folder_create`

Create Rule Folder · Write

Create a folder for custom rules on a profile; its rules inherit the folder's action.
Returns the new folder.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `do` (`integer`, required): Rule action: 0 BLOCK, 1 BYPASS, 2 SPOOF (answer with via), 3 REDIRECT (through the proxy location in via). Example: 0. One of: `0`, `1`, `2`, `3`.
- `name` (`string`, required): Folder name. Example: Work tools.
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `status` (`integer`, required): 1 to enable the folder and its rules, 0 to disable. Example: 1. One of: `0`, `1`.
- `via` (`string`, optional): Target for SPOOF (an IPv4 address or hostname) or REDIRECT (a proxy location ID from controld_proxies_list). Example: 203.0.113.10.

Example input: `{"do":0,"name":"<name>","profile_id":"<profile_id>","status":1}`

### `controld_profile_folder_update`

Update Rule Folder · Write

Rename a rule folder or change its action or status.
Returns the updated folder.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `do` (`integer`, required): Rule action: 0 BLOCK, 1 BYPASS, 2 SPOOF (answer with via), 3 REDIRECT (through the proxy location in via). Example: 0. One of: `0`, `1`, `2`, `3`.
- `folder` (`string`, required): Folder ID. Get it from controld_profile_folders_list. Example: 54321.
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `status` (`integer`, required): 1 to enable the folder and its rules, 0 to disable. Example: 1. One of: `0`, `1`.
- `name` (`string`, optional): New folder name. Example: Work tools.
- `via` (`string`, optional): Target for SPOOF (an IPv4 address or hostname) or REDIRECT (a proxy location ID from controld_proxies_list). Example: 203.0.113.10.

Example input: `{"do":0,"folder":"<folder>","profile_id":"<profile_id>","status":1}`

### `controld_profile_option_set`

Set Profile Option · Write

Turn a profile option on or off, or set its value.
Returns the updated option.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `option_name` (`string`, required): Name (PK) of the option. Get it from controld_profile_options_list. Example: safesearch.
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `status` (`integer`, required): 1 to enable the option, 0 to disable it. Example: 1. One of: `0`, `1`.
- `value` (`string`, optional): Value for options that take one. Example: 1.

Example input: `{"option_name":"<option_name>","profile_id":"<profile_id>","status":1}`

### `controld_profile_restriction_set`

Set Profile Restriction · Write

Enable or disable a restriction on a profile.
Returns the updated restriction.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `restriction_id` (`string`, required): Restriction ID (PK). Get it from controld_restrictions_list. Example: geo_cn.
- `status` (`integer`, required): 1 to enable the restriction, 0 to disable it. Example: 1. One of: `0`, `1`.

Example input: `{"profile_id":"<profile_id>","restriction_id":"<restriction_id>","status":1}`

### `controld_profile_rules_create`

Create Custom Rules · Write

Create custom rules that block, bypass, spoof or redirect one or more hostnames on a profile.
Returns the created rules.
Use controld_profile_rules_update to change existing rules.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `do` (`integer`, required): Rule action: 0 BLOCK, 1 BYPASS, 2 SPOOF (answer with via), 3 REDIRECT (through the proxy location in via). Example: 0. One of: `0`, `1`, `2`, `3`.
- `hostnames` (`array`, required): Hostnames the rule applies to; wildcards like *.example.com are allowed. Example: ["ads.example.com", "*.tracker.example"].
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `status` (`integer`, required): 1 to enable the rules, 0 to create them disabled. Example: 1. One of: `0`, `1`.
- `comment` (`string`, optional): Comment for the rules, up to 64 characters. Example: Blocked by IT.
- `group` (`integer`, optional): ID of the folder to put the rules in; leave empty for the root. Example: 54321.
- `via` (`string`, optional): Target for SPOOF (an IPv4 address or hostname) or REDIRECT (a proxy location ID from controld_proxies_list). Example: 203.0.113.10.
- `via_v6` (`string`, optional): IPv6 address to answer with (AAAA) when do is SPOOF. Example: 2001:db8::10.

Example input: `{"do":0,"hostnames":["ads.example.com","*.tracker.example"],"profile_id":"<profile_id>","status":1}`

### `controld_profile_rules_update`

Update Custom Rules · Write

Change the action, target, folder or status of existing custom rules for one or more hostnames.
Returns the updated rules.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `do` (`integer`, required): Rule action: 0 BLOCK, 1 BYPASS, 2 SPOOF (answer with via), 3 REDIRECT (through the proxy location in via). Example: 0. One of: `0`, `1`, `2`, `3`.
- `hostnames` (`array`, required): Hostnames of the rules to change. Example: ["ads.example.com"].
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `status` (`integer`, required): 1 to enable the rules, 0 to disable them. Example: 1. One of: `0`, `1`.
- `comment` (`string`, optional): Comment for the rules, up to 64 characters. Example: Blocked by IT.
- `group` (`integer`, optional): ID of the folder to move the rules to. Example: 54321.
- `via` (`string`, optional): Target for SPOOF (an IPv4 address or hostname) or REDIRECT (a proxy location ID from controld_proxies_list). Example: 203.0.113.10.
- `via_v6` (`string`, optional): IPv6 address to answer with (AAAA) when do is SPOOF. Example: 2001:db8::10.

Example input: `{"do":0,"hostnames":["ads.example.com"],"profile_id":"<profile_id>","status":1}`

### `controld_profile_service_set`

Set Profile Service Rule · Write

Block, bypass, spoof or redirect a service (such as tiktok or netflix) on a profile.
Returns the updated service rule.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `do` (`integer`, required): Rule action: 0 BLOCK, 1 BYPASS, 2 SPOOF (answer with via), 3 REDIRECT (through the proxy location in via). Example: 0. One of: `0`, `1`, `2`, `3`.
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `service` (`string`, required): Service ID, such as tiktok. Get it from controld_services_list. Example: tiktok.
- `status` (`integer`, required): 1 to enable the rule, 0 to disable it. Example: 1. One of: `0`, `1`.
- `via` (`string`, optional): Target for SPOOF (an IPv4 address or hostname) or REDIRECT (a proxy location ID from controld_proxies_list). Example: 203.0.113.10.
- `via_v6` (`string`, optional): IPv6 address to answer with (AAAA) when do is SPOOF. Example: 2001:db8::10.

Example input: `{"do":0,"profile_id":"<profile_id>","service":"<service>","status":1}`

### `controld_profile_update`

Update Profile · Write

Rename a profile, pause it until a time, or lock or unlock it.
Returns the updated profile.
Only the fields you pass change.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `disable_ttl` (`integer`, optional): Pause the profile until this Unix timestamp; 0 re-enables it. Example: 0.
- `lock_message` (`string`, optional): Message shown when someone edits a locked profile. Example: Ask a parent first.
- `lock_status` (`integer`, optional): 1 to lock the profile against edits, 0 to unlock. Example: 0.
- `name` (`string`, optional): Rename profile to this name. Example: Kids devices.
- `password` (`string`, optional): Account password, needed to unlock a profile. Example: account-password.

Example input: `{"profile_id":"<profile_id>"}`

### `controld_device_delete`

Delete Endpoint · Destructive

Delete an endpoint. Devices using its resolver stop being filtered.
Returns an empty success response.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `device_id` (`string`, required): ID (PK) of the endpoint (device or resolver). Get it from controld_devices_list. Example: abcd1234efgh.

Example input: `{"device_id":"<device_id>"}`

### `controld_device_ips_remove`

Remove Endpoint IPs · Destructive

Remove learned or authorized IP addresses from an endpoint.
Returns a success response.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `device_id` (`string`, required): ID (PK) of the endpoint (device or resolver). Get it from controld_devices_list. Example: abcd1234efgh.
- `ips` (`array`, required): IPv4 or IPv6 addresses to remove. Example: ["203.0.113.7"].

Example input: `{"device_id":"<device_id>","ips":["203.0.113.7"]}`

### `controld_internal_domain_delete`

Delete Internal Domain · Destructive

Delete an internal domain entry.
Returns an empty success response.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `entry_id` (`string`, required): ID of the entry. Get it from controld_internal_domains_list. Example: 42.
- `x_force_org_id` (`string`, optional): Sub-organization ID to act in, for parent organization accounts. Example: org_12345.

Example input: `{"entry_id":"<entry_id>"}`

### `controld_profile_delete`

Delete Profile · Destructive

Delete a profile. Endpoints using it must be moved to another profile first.
Returns an empty success response.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"profile_id":"<profile_id>"}`

### `controld_profile_folder_delete`

Delete Rule Folder · Destructive

Delete a rule folder and the rules in it.
Returns an empty success response.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `folder` (`string`, required): Folder ID. Get it from controld_profile_folders_list. Example: 54321.
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"folder":"<folder>","profile_id":"<profile_id>"}`

### `controld_profile_restriction_disable`

Disable Profile Restriction · Destructive

Disable a restriction on a profile.
Returns an empty success response.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.
- `restriction_id` (`string`, required): Restriction ID (PK). Get it from controld_profile_restrictions_list. Example: geo_cn.

Example input: `{"profile_id":"<profile_id>","restriction_id":"<restriction_id>"}`

### `controld_profile_rule_delete`

Delete Custom Rule · Destructive

Delete the custom rule for a hostname on a profile.
Returns an empty success response.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `hostname` (`string`, required): Hostname of the rule to delete. Example: ads.example.com.
- `profile_id` (`string`, required): ID (PK) of the profile. Get it from controld_profiles_list. Example: 123456abcdef.

Example input: `{"hostname":"<hostname>","profile_id":"<profile_id>"}`

## Related

Other Developer Tools connectors ([all 200](/agentkit/connectors/?category=developer-tools)):

- [GitHub](/agentkit/connectors/github/): Scalekit connector, OAuth, 217 tools
- [Datadog](/agentkit/connectors/datadog/): Scalekit connector, API key, 105 tools
- [Linear](/agentkit/connectors/linear/): Scalekit connector, OAuth, 64 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
