Skip to main content
POST
/
core.v1.ConnectorService
/
CreateConnectorListenerRule
cURL
curl -X POST "https://api.joinformal.com/core.v1.ConnectorService/CreateConnectorListenerRule" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "connectorListenerRule": {
    "id": "<string>",
    "listener": {
      "id": "<string>",
      "name": "<string>",
      "port": 123,
      "terminationProtection": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "connector": {
        "id": "<string>",
        "name": "<string>",
        "terminationProtection": true,
        "spaceId": "<string>",
        "space": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "terminationProtection": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    },
    "type": "technology",
    "rule": "<string>",
    "terminationProtection": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
​
connectorListenerId
string
Minimum string length: 1
​
type
enum<string>
Available options:
technology,
any,
resource
​
rule
string
Pattern: ^(any|resource_.*|datastore_.*|athena|bigquery|clickhouse|dynamodb|elastic|http|kafka|kubernetes|mariadb|mongodb|mssqlserver|mysql|postgres|rdp|redis|s3|snowflake|ssh)$
​
terminationProtection
boolean

Response

Success

​
connectorListenerRule
connector_listener_rule · object