Applications Management

Register external app

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

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

application/json

namestringRequired

name should be unique, alphanumeric set of characters

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

409

The supplied identifier is already being used by another resource

application/json

500

An internal server error has occurred

application/json

post

/api/v1/environments/{environment}/proxy/api/v1/apps/external

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v1/apps/external HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

Delete external app

delete

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

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

appNamestringRequired

The unique identifier for the app

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

/api/v1/environments/{environment}/proxy/api/v1/apps/external/{appName}

HTTPcURLJavaScriptPython

DELETE /api/v1/environments/{environment}/proxy/api/v1/apps/external/{appName} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete external app runners

delete

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

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

appNamestringRequired

The unique identifier for the app

Body

application/json

runnersstring[] · min: 1Required

A list of runners urls

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

/api/v1/environments/{environment}/proxy/api/v1/apps/external/{appName}/runners

HTTPcURLJavaScriptPython

DELETE /api/v1/environments/{environment}/proxy/api/v1/apps/external/{appName}/runners HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "runners": [
    "text"
  ]
}

No content

Set application description

put

Sets an application description. Will respond with a bad request if a blank description is supplied

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

applicationIdstring · min: 1RequiredExample: application-id

Body

application/json

descriptionstring · min: 1Optional

Responses

204Success

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

/api/v1/environments/{environment}/proxy/api/v1/apps/{applicationId}/description

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v1/apps/{applicationId}/description HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "description": "Aggregates distances by driver"
}

No content

List application tags

get

Get applications tags filtered by a matching supplied query

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Query parameters

querystringOptional

Match tag by keyword

Example: user

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

/api/v1/environments/{environment}/proxy/api/v1/apps/tags

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environment}/proxy/api/v1/apps/tags HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tags": [
    "user-generated-content",
    "user-details",
    "testuser"
  ]
}

Set application tags

put

Annotates an application with a list of tags. Will respond with a bad request if tags are empty, contain whitespaces or ar longer than 255

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

applicationIdstring · min: 1RequiredExample: application-id

Body

application/json

tagsstring[]Optional

Responses

204Success

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

/api/v1/environments/{environment}/proxy/api/v1/apps/{applicationId}/tags

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v1/apps/{applicationId}/tags HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "tags": [
    "aggregation"
  ]
}

No content