ngrok-access

Ngrok API keys, credentials, IP policies, and users

Server path: /ngrok-access | Type: Application | PCID required: Yes

Tools

Tool	Description
ngrok_access_api_keys_create	Create
ngrok_access_api_keys_delete	Delete
ngrok_access_api_keys_get	Get
ngrok_access_api_keys_list	List
ngrok_access_api_keys_update	Update
ngrok_access_application_sessions_delete	Delete
ngrok_access_application_sessions_get	Get
ngrok_access_application_sessions_list	List
ngrok_access_application_users_delete	Delete
ngrok_access_application_users_get	Get
ngrok_access_application_users_list	List
ngrok_access_bot_users_create	Create
ngrok_access_bot_users_delete	Delete
ngrok_access_bot_users_get	Get
ngrok_access_bot_users_list	List
ngrok_access_bot_users_update	Update
ngrok_access_credentials_create	Create
ngrok_access_credentials_delete	Delete
ngrok_access_credentials_get	Get
ngrok_access_credentials_list	List
ngrok_access_credentials_update	Update
ngrok_access_ip_policies_create	Create
ngrok_access_ip_policies_delete	Delete
ngrok_access_ip_policies_get	Get
ngrok_access_ip_policies_list	List
ngrok_access_ip_policies_update	Update
ngrok_access_ip_policy_rules_create	Create
ngrok_access_ip_policy_rules_delete	Delete
ngrok_access_ip_policy_rules_get	Get
ngrok_access_ip_policy_rules_list	List
ngrok_access_ip_policy_rules_update	Update
ngrok_access_ip_restrictions_create	Create
ngrok_access_ip_restrictions_delete	Delete
ngrok_access_ip_restrictions_get	Get
ngrok_access_ip_restrictions_list	List
ngrok_access_ip_restrictions_update	Update
ngrok_access_service_users_create	Create
ngrok_access_service_users_delete	Delete
ngrok_access_service_users_get	Get
ngrok_access_service_users_list	List
ngrok_access_service_users_update	Update

---

ngrok_access_api_keys_create

Create

Parameters:

Parameter	Type	Required	Default	Description
description	string	No	—	human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
metadata	string	No	—	arbitrary user-defined data of this API key. optional, max 4096 bytes
owner_id	string	No	—	If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "description": {
      "type": "string",
      "description": "human-readable description of what uses the API key to authenticate. optional, max 255 bytes."
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined data of this API key. optional, max 4096 bytes"
    },
    "owner_id": {
      "type": "string",
      "description": "If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot."
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_api_keys_delete

Delete

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_api_keys_get

Get

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_api_keys_list

List

Parameters:

Parameter	Type	Required	Default	Description
before_id	string	No	—	Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limit	string	No	—	Constrains the number of results in the dataset. See the API Overview for details.
filter	string	No	—	A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "before_id": {
      "type": "string",
      "description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
    },
    "limit": {
      "type": "string",
      "description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
    },
    "filter": {
      "type": "string",
      "description": "A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as `id`, `metadata`, `created_at`, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering."
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_api_keys_update

Update

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
description	string	No	—	human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
metadata	string	No	—	arbitrary user-defined data of this API key. optional, max 4096 bytes

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "description": {
      "type": "string",
      "description": "human-readable description of what uses the API key to authenticate. optional, max 255 bytes."
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined data of this API key. optional, max 4096 bytes"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_application_sessions_delete

Delete

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_application_sessions_get

Get

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_application_sessions_list

List

Parameters:

Parameter	Type	Required	Default	Description
before_id	string	No	—	Before Id
limit	string	No	—	Maximum number of results to return

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "before_id": {
      "type": "string",
      "description": "Before Id"
    },
    "limit": {
      "type": "string",
      "description": "Maximum number of results to return"
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_application_users_delete

Delete

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_application_users_get

Get

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_application_users_list

List

Parameters:

Parameter	Type	Required	Default	Description
before_id	string	No	—	Before Id
limit	string	No	—	Maximum number of results to return

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "before_id": {
      "type": "string",
      "description": "Before Id"
    },
    "limit": {
      "type": "string",
      "description": "Maximum number of results to return"
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_bot_users_create

Create

Parameters:

Parameter	Type	Required	Default	Description
active	boolean	No	—	whether or not the bot is active
name	string	No	—	human-readable name used to identify the bot

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "active": {
      "type": "boolean",
      "description": "whether or not the bot is active"
    },
    "name": {
      "type": "string",
      "description": "human-readable name used to identify the bot"
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_bot_users_delete

Delete

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_bot_users_get

Get

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_bot_users_list

List

Parameters:

Parameter	Type	Required	Default	Description
before_id	string	No	—	Before Id
limit	string	No	—	Maximum number of results to return

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "before_id": {
      "type": "string",
      "description": "Before Id"
    },
    "limit": {
      "type": "string",
      "description": "Maximum number of results to return"
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_bot_users_update

Update

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
active	boolean	No	—	whether or not the bot is active
name	string	No	—	human-readable name used to identify the bot

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "active": {
      "type": "boolean",
      "description": "whether or not the bot is active"
    },
    "name": {
      "type": "string",
      "description": "human-readable name used to identify the bot"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_credentials_create

Create

Parameters:

Parameter	Type	Required	Default	Description
acl	string[]	No	—	optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
description	string	No	—	human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
metadata	string	No	—	arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
owner_id	string	No	—	If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "acl": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the `bind` rule. The `bind` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule `bind:example.ngrok.io`. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of `bind:*.example.com` which will allow `x.example.com`, `y.example.com`, `*.example.com`, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of `bind:*=example` which will allow `x=example`, `y=example`, etc. A rule of `'*'` is equivalent to no acl at all and will explicitly permit all actions."
    },
    "description": {
      "type": "string",
      "description": "human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes."
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes."
    },
    "owner_id": {
      "type": "string",
      "description": "If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID."
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_credentials_delete

Delete

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_credentials_get

Get

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_credentials_list

List

Parameters:

Parameter	Type	Required	Default	Description
before_id	string	No	—	Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limit	string	No	—	Constrains the number of results in the dataset. See the API Overview for details.
filter	string	No	—	A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "before_id": {
      "type": "string",
      "description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
    },
    "limit": {
      "type": "string",
      "description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
    },
    "filter": {
      "type": "string",
      "description": "A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as `id`, `metadata`, `created_at`, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering."
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_credentials_update

Update

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
acl	string[]	No	—	optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
description	string	No	—	human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
metadata	string	No	—	arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "acl": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the `bind` rule. The `bind` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule `bind:example.ngrok.io`. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of `bind:*.example.com` which will allow `x.example.com`, `y.example.com`, `*.example.com`, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of `bind:*=example` which will allow `x=example`, `y=example`, etc. A rule of `'*'` is equivalent to no acl at all and will explicitly permit all actions."
    },
    "description": {
      "type": "string",
      "description": "human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes."
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_ip_policies_create

Create

Parameters:

Parameter	Type	Required	Default	Description
description	string	No	—	human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
metadata	string	No	—	arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "description": {
      "type": "string",
      "description": "human-readable description of the source IPs of this IP policy. optional, max 255 bytes."
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes."
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_ip_policies_delete

Delete

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_ip_policies_get

Get

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_ip_policies_list

List

Parameters:

Parameter	Type	Required	Default	Description
before_id	string	No	—	Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limit	string	No	—	Constrains the number of results in the dataset. See the API Overview for details.
filter	string	No	—	A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "before_id": {
      "type": "string",
      "description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
    },
    "limit": {
      "type": "string",
      "description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
    },
    "filter": {
      "type": "string",
      "description": "A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as `id`, `metadata`, `created_at`, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering."
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_ip_policies_update

Update

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
description	string	No	—	human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
metadata	string	No	—	arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "description": {
      "type": "string",
      "description": "human-readable description of the source IPs of this IP policy. optional, max 255 bytes."
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_ip_policy_rules_create

Create

Parameters:

Parameter	Type	Required	Default	Description
action	string	Yes	—	the action to apply to the policy rule, either allow or deny
cidr	string	Yes	—	an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
description	string	No	—	human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
ip_policy_id	string	Yes	—	ID of the IP policy this IP policy rule will be attached to
metadata	string	No	—	arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "action": {
      "type": "string",
      "description": "the action to apply to the policy rule, either `allow` or `deny`"
    },
    "cidr": {
      "type": "string",
      "description": "an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported."
    },
    "description": {
      "type": "string",
      "description": "human-readable description of the source IPs of this IP rule. optional, max 255 bytes."
    },
    "ip_policy_id": {
      "type": "string",
      "description": "ID of the IP policy this IP policy rule will be attached to"
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes."
    }
  },
  "required": [
    "PCID",
    "action",
    "cidr",
    "ip_policy_id"
  ]
}

---

ngrok_access_ip_policy_rules_delete

Delete

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_ip_policy_rules_get

Get

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_ip_policy_rules_list

List

Parameters:

Parameter	Type	Required	Default	Description
before_id	string	No	—	Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limit	string	No	—	Constrains the number of results in the dataset. See the API Overview for details.
filter	string	No	—	A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "before_id": {
      "type": "string",
      "description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
    },
    "limit": {
      "type": "string",
      "description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
    },
    "filter": {
      "type": "string",
      "description": "A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as `id`, `metadata`, `created_at`, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering."
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_ip_policy_rules_update

Update

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
cidr	string	No	—	an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
description	string	No	—	human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
metadata	string	No	—	arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "cidr": {
      "type": "string",
      "description": "an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported."
    },
    "description": {
      "type": "string",
      "description": "human-readable description of the source IPs of this IP rule. optional, max 255 bytes."
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_ip_restrictions_create

Create

Parameters:

Parameter	Type	Required	Default	Description
description	string	No	—	human-readable description of this IP restriction. optional, max 255 bytes.
enforced	boolean	No	—	true if the IP restriction will be enforced. if false, only warnings will be issued
ip_policy_ids	string[]	Yes	—	the set of IP policy identifiers that are used to enforce the restriction
metadata	string	No	—	arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
type	string	Yes	—	the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "description": {
      "type": "string",
      "description": "human-readable description of this IP restriction. optional, max 255 bytes."
    },
    "enforced": {
      "type": "boolean",
      "description": "true if the IP restriction will be enforced. if false, only warnings will be issued"
    },
    "ip_policy_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "the set of IP policy identifiers that are used to enforce the restriction"
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes."
    },
    "type": {
      "type": "string",
      "description": "the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: `dashboard`, `api`, `agent`, and `endpoints`"
    }
  },
  "required": [
    "PCID",
    "ip_policy_ids",
    "type"
  ]
}

---

ngrok_access_ip_restrictions_delete

Delete

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_ip_restrictions_get

Get

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_ip_restrictions_list

List

Parameters:

Parameter	Type	Required	Default	Description
before_id	string	No	—	Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limit	string	No	—	Constrains the number of results in the dataset. See the API Overview for details.
filter	string	No	—	A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "before_id": {
      "type": "string",
      "description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
    },
    "limit": {
      "type": "string",
      "description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
    },
    "filter": {
      "type": "string",
      "description": "A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as `id`, `metadata`, `created_at`, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering."
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_ip_restrictions_update

Update

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
description	string	No	—	human-readable description of this IP restriction. optional, max 255 bytes.
enforced	boolean	No	—	true if the IP restriction will be enforced. if false, only warnings will be issued
ip_policy_ids	string[]	No	—	the set of IP policy identifiers that are used to enforce the restriction
metadata	string	No	—	arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "description": {
      "type": "string",
      "description": "human-readable description of this IP restriction. optional, max 255 bytes."
    },
    "enforced": {
      "type": "boolean",
      "description": "true if the IP restriction will be enforced. if false, only warnings will be issued"
    },
    "ip_policy_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "the set of IP policy identifiers that are used to enforce the restriction"
    },
    "metadata": {
      "type": "string",
      "description": "arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_service_users_create

Create

Parameters:

Parameter	Type	Required	Default	Description
active	boolean	No	—	whether or not the service is active
name	string	No	—	human-readable name used to identify the service

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "active": {
      "type": "boolean",
      "description": "whether or not the service is active"
    },
    "name": {
      "type": "string",
      "description": "human-readable name used to identify the service"
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_service_users_delete

Delete

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_service_users_get

Get

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	a resource identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "a resource identifier"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ngrok_access_service_users_list

List

Parameters:

Parameter	Type	Required	Default	Description
before_id	string	No	—	Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limit	string	No	—	Constrains the number of results in the dataset. See the API Overview for details.
filter	string	No	—	A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "before_id": {
      "type": "string",
      "description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
    },
    "limit": {
      "type": "string",
      "description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
    },
    "filter": {
      "type": "string",
      "description": "A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as `id`, `metadata`, `created_at`, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering."
    }
  },
  "required": [
    "PCID"
  ]
}

---

ngrok_access_service_users_update

Update

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
active	boolean	No	—	whether or not the service is active
name	string	No	—	human-readable name used to identify the service

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "active": {
      "type": "boolean",
      "description": "whether or not the service is active"
    },
    "name": {
      "type": "string",
      "description": "human-readable name used to identify the service"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}