Applications Management
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
The bearer token can be obtained by creating a ServiceAccount.
name should be unique, alphanumeric set of characters
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
The supplied identifier is already being used by another resource
An internal server error has occurred
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
Remove External Apps. This action will remove the external app as well as all the instances of the App
The bearer token can be obtained by creating a ServiceAccount.
The unique identifier for the app
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
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
Remove External App Runners. This action will remove the runners from its App
The bearer token can be obtained by creating a ServiceAccount.
The unique identifier for the app
A list of runners urls
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
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
Sets an application description. Will respond with a bad request if a blank description is supplied
The bearer token can be obtained by creating a ServiceAccount.
application-idThe request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
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
Get applications tags filtered by a matching supplied query
The bearer token can be obtained by creating a ServiceAccount.
Match tag by keyword
userThe request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
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"
]
}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
The bearer token can be obtained by creating a ServiceAccount.
application-idThe request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
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
Last updated
Was this helpful?