External Applications

PreviousKafka Connectors NextKafka ACLs & Quotas

Last updated 6 days ago

Was this helpful?

delete

Remove External Apps. This action will remove the external app as well as all the instances of the App

Path parameters

appNamestringRequired

The unique identifier for the app

Responses

application/json

delete

DELETE /api/v1/environments/{name}/proxy/api/v1/apps/external/{appName} HTTP/1.1
Host: 
Accept: */*

No content

delete

Remove External App Runners. This action will remove the runners from its App

Path parameters

appNamestringRequired

The unique identifier for the app

Body

runnersstring[] · min: 1Required

A list of runners urls

Responses

application/json

delete

DELETE /api/v1/environments/{name}/proxy/api/v1/apps/external/{appName}/runners HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "runners": [
    "text"
  ]
}

No content

post

Register External Apps or App Runners. This endpoint is used to register a brand new app, or to update an existing one with more Runners

Body

namestringRequired

name should be unique, alphanumeric set of characters

metadataobjectRequired

inputobject[]Optional

outputobject[]Optional

runnersobject[]Optional

Responses

application/json

post

POST /api/v1/environments/{name}/proxy/api/v1/apps/external HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "name": "text",
  "metadata": {
    "version": "text",
    "description": "text",
    "owner": "text",
    "appType": "text",
    "tags": [
      "text"
    ],
    "deployment": "text"
  },
  "input": [
    {
      "name": "text"
    }
  ],
  "output": [
    {
      "name": "text"
    }
  ],
  "runners": [
    {
      "url": "text",
      "name": "text",
      "healthCheckInterval": 1
    }
  ]
}

No content