/ngrok-events | Type: Application | PCID required: Yes
Tools
ngrok_events_event_destinations_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Human-readable description of the Event Destination. Optional, max 255 bytes. |
format | string | No | — | The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON. |
metadata | string | No | — | Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes. |
target | object | No | — | The target value |
Show inputSchema
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 Event Destination. Optional, max 255 bytes."
},
"format": {
"type": "string",
"description": "The output format you would like to serialize events into when sending to their target. Currently the only accepted value is `JSON`."
},
"metadata": {
"type": "string",
"description": "Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes."
},
"target": {
"type": "object",
"description": "The target value",
"properties": {
"firehose": {
"type": "object",
"description": "The firehose value"
},
"kinesis": {
"type": "object",
"description": "The kinesis value"
},
"cloudwatch_logs": {
"type": "object",
"description": "Cloudwatch Logs"
},
"datadog": {
"type": "object",
"description": "The datadog value"
},
"azure_logs_ingestion": {
"type": "object",
"description": "Azure Logs Ingestion"
}
}
}
},
"required": [
"PCID"
]
}
ngrok_events_event_destinations_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
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_events_event_destinations_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
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_events_event_destinations_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
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_events_event_destinations_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Unique identifier for this Event Destination. |
description | string | No | — | Human-readable description of the Event Destination. Optional, max 255 bytes. |
format | string | No | — | The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON. |
metadata | string | No | — | Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes. |
target | object | No | — | The target value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Unique identifier for this Event Destination."
},
"description": {
"type": "string",
"description": "Human-readable description of the Event Destination. Optional, max 255 bytes."
},
"format": {
"type": "string",
"description": "The output format you would like to serialize events into when sending to their target. Currently the only accepted value is `JSON`."
},
"metadata": {
"type": "string",
"description": "Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes."
},
"target": {
"type": "object",
"description": "The target value",
"properties": {
"firehose": {
"type": "object",
"description": "The firehose value"
},
"kinesis": {
"type": "object",
"description": "The kinesis value"
},
"cloudwatch_logs": {
"type": "object",
"description": "Cloudwatch Logs"
},
"datadog": {
"type": "object",
"description": "The datadog value"
},
"azure_logs_ingestion": {
"type": "object",
"description": "Azure Logs Ingestion"
}
}
}
},
"required": [
"PCID",
"id"
]
}
ngrok_events_event_sources_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_id | string | Yes | — | The unique identifier for the Event Subscription that this Event Source is attached to. |
type | string | No | — | Type of event for which an event subscription will trigger |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subscription_id": {
"type": "string",
"description": "The unique identifier for the Event Subscription that this Event Source is attached to."
},
"type": {
"type": "string",
"description": "Type of event for which an event subscription will trigger"
}
},
"required": [
"PCID",
"subscription_id"
]
}
ngrok_events_event_sources_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_id | string | Yes | — | The unique identifier for the Event Subscription that this Event Source is attached to. |
type | string | Yes | — | Type of event for which an event subscription will trigger |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subscription_id": {
"type": "string",
"description": "The unique identifier for the Event Subscription that this Event Source is attached to."
},
"type": {
"type": "string",
"description": "Type of event for which an event subscription will trigger"
}
},
"required": [
"PCID",
"subscription_id",
"type"
]
}
ngrok_events_event_sources_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_id | string | Yes | — | The unique identifier for the Event Subscription that this Event Source is attached to. |
type | string | Yes | — | Type of event for which an event subscription will trigger |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subscription_id": {
"type": "string",
"description": "The unique identifier for the Event Subscription that this Event Source is attached to."
},
"type": {
"type": "string",
"description": "Type of event for which an event subscription will trigger"
}
},
"required": [
"PCID",
"subscription_id",
"type"
]
}
ngrok_events_event_sources_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_id | string | Yes | — | The unique identifier for the Event Subscription that this Event Source is attached to. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subscription_id": {
"type": "string",
"description": "The unique identifier for the Event Subscription that this Event Source is attached to."
}
},
"required": [
"PCID",
"subscription_id"
]
}
ngrok_events_event_sources_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_id | string | Yes | — | The unique identifier for the Event Subscription that this Event Source is attached to. |
type | string | Yes | — | Type of event for which an event subscription will trigger |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subscription_id": {
"type": "string",
"description": "The unique identifier for the Event Subscription that this Event Source is attached to."
},
"type": {
"type": "string",
"description": "Type of event for which an event subscription will trigger"
}
},
"required": [
"PCID",
"subscription_id",
"type"
]
}
ngrok_events_event_subscriptions_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars. |
destination_ids | string[] | No | — | A list of Event Destination IDs which should be used for this Event Subscription. |
metadata | string | No | — | Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars. |
sources | object[] | No | — | Sources containing the types for which this event subscription will trigger |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars."
},
"destination_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of Event Destination IDs which should be used for this Event Subscription."
},
"metadata": {
"type": "string",
"description": "Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of event for which an event subscription will trigger"
}
}
},
"description": "Sources containing the types for which this event subscription will trigger"
}
},
"required": [
"PCID"
]
}
ngrok_events_event_subscriptions_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
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_events_event_subscriptions_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
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_events_event_subscriptions_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
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_events_event_subscriptions_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Unique identifier for this Event Subscription. |
description | string | No | — | Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars. |
destination_ids | string[] | No | — | A list of Event Destination IDs which should be used for this Event Subscription. |
metadata | string | No | — | Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars. |
sources | object[] | No | — | Sources containing the types for which this event subscription will trigger |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Unique identifier for this Event Subscription."
},
"description": {
"type": "string",
"description": "Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars."
},
"destination_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of Event Destination IDs which should be used for this Event Subscription."
},
"metadata": {
"type": "string",
"description": "Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of event for which an event subscription will trigger"
}
}
},
"description": "Sources containing the types for which this event subscription will trigger"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_events_secrets_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | description of Secret |
metadata | string | No | — | Arbitrary user-defined metadata for this Secret |
name | string | No | — | Name of secret |
value | string | No | — | Value of secret |
vault_id | string | No | — | unique identifier of the referenced vault |
vault_name | string | No | — | name of the referenced vault |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "description of Secret"
},
"metadata": {
"type": "string",
"description": "Arbitrary user-defined metadata for this Secret"
},
"name": {
"type": "string",
"description": "Name of secret"
},
"value": {
"type": "string",
"description": "Value of secret"
},
"vault_id": {
"type": "string",
"description": "unique identifier of the referenced vault"
},
"vault_name": {
"type": "string",
"description": "name of the referenced vault"
}
},
"required": [
"PCID"
]
}
ngrok_events_secrets_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
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_events_secrets_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
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_events_secrets_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
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_events_secrets_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | identifier for Secret |
description | string | No | — | description of Secret |
metadata | string | No | — | Arbitrary user-defined metadata for this Secret |
name | string | No | — | Name of secret |
value | string | No | — | Value of secret |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "identifier for Secret"
},
"description": {
"type": "string",
"description": "description of Secret"
},
"metadata": {
"type": "string",
"description": "Arbitrary user-defined metadata for this Secret"
},
"name": {
"type": "string",
"description": "Name of secret"
},
"value": {
"type": "string",
"description": "Value of secret"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_events_vaults_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | description of Vault |
metadata | string | No | — | Arbitrary user-defined metadata for this Vault |
name | string | No | — | Name of vault |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "description of Vault"
},
"metadata": {
"type": "string",
"description": "Arbitrary user-defined metadata for this Vault"
},
"name": {
"type": "string",
"description": "Name of vault"
}
},
"required": [
"PCID"
]
}
ngrok_events_vaults_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
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_events_vaults_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
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_events_vaults_get_secrets_by_vault
GetSecretsByVault Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
before_id | string | No | — | Before Id |
limit | string | No | — | Maximum number of results to return |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
},
"before_id": {
"type": "string",
"description": "Before Id"
},
"limit": {
"type": "string",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_events_vaults_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
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_events_vaults_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | identifier for Vault |
description | string | No | — | description of Vault |
metadata | string | No | — | Arbitrary user-defined metadata for this Vault |
name | string | No | — | Name of vault |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "identifier for Vault"
},
"description": {
"type": "string",
"description": "description of Vault"
},
"metadata": {
"type": "string",
"description": "Arbitrary user-defined metadata for this Vault"
},
"name": {
"type": "string",
"description": "Name of vault"
}
},
"required": [
"PCID",
"id"
]
}