luna-lambda API (v.0.3.7)

Download OpenAPI specification:Download

'VisionLabs luna-lambda' is service intended for manage luna user lambdas.

Luna-user-lambda represents separate service which can process user requests using code created by user.

For information about lambda representation and requirements - see development manual.

version

get version

get service version

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500

Content type

application/json

{"Version": {"api": 1,
"major": 0,
"minor": 0,
"patch": 0
}
}

lambdas creation

create lambda

Start new lambda creation process.

Lambda creation comprises in two parts:

docker image creation | process can be seen by image monitoring
lambda creation and launching | process can be seen by lambda monitoring

After lambda creation process will be completed lambda status will be changed to running and it will be ready to process requests. For more details see development manual.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type required	string Value: "multipart/form-data" The request content type header.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Request Body schema: multipart/form-data

archive required	string <binary> Archive file with zip extension. Content-Type must be "application/zip".
required	object Lambda credentials. Content-Type must be "application/json".
	object Parameters for lambda. Content-Type must be "application/json".
	object (deploy_parameters) Deploy parameters for lambda. Content-Type must be "application/json".

Responses

Response samples

202
400
403
409
500

Content type

application/json

{"lambda_id": "string"
}

put lambda

Execute lambda recreation.

The lambda version will be incremented after recreation finish.

Lambda recreation comprises in three parts:

old lambda removing
docker image creation | process can be seen by image monitoring
lambda creation and launching | process can be seen by lambda monitoring

After lambda creation process will be completed lambda status will be changed to running and it will be ready to process requests. For more details see development manual.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type required	string Value: "multipart/form-data" The request content type header.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Request Body schema: multipart/form-data

archive required	string <binary> Archive file with zip extension. Content-Type must be "application/zip".
required	object Lambda credentials. Content-Type must be "application/json".
	object Parameters for lambda. Content-Type must be "application/json".
	object (deploy_parameters) Deploy parameters for lambda. Content-Type must be "application/json".

Responses

Response samples

Content type

application/json

{"version": 5
}

patch lambda

patch lambda.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Value: "application/json" The request content type header.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Request Body schema: application/json

non-empty

lambda_name	string (lambda_name) Lambda name. Each user can create only lambdas with unique names.
description	string <= 256 characters lambda description

Responses

Request samples

Payload

Content type

application/json

{"lambda_name": "first-lambda",
"description": "very useful lambda"
}

Response samples

400
404
500

Content type

application/json

Example

account_id_not_found

{"error_code": 11066,
"desc": "Bad/incomplete input data",
"detail": "Luna-Account-Id header not found",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11066"
}

lambda monitoring

get lambdas

Get lambdas according to filters.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
create_time__lt	string <date-time> (time) Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
create_time__gte	string <date-time> (time) Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
page	integer >= 1 Default: 1 a page number.
page_size	integer [ 1 .. 100 ] Default: 10 the number of items on page.
lambda_type	string Enum: "standalone" "handlers" "tasks" Lambda type.
lambda_name	string Find all objects with `lambda_name` similar to this parameter. You can specify only part of the `lambda_name` value for this filter.
namespace	Array of strings (namespace) Example: namespace=default,no-default-namespace Comma-separated list of lambda namespaces. Each namespace must match the pattern `^[a-z0-9][a-z0-9-]*[a-z0-9]$`

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
500

Content type

application/json

{"lambdas": [{"account_id": "0468ca85-f6ca-4841-b30c-5ccc26b6f397",
"lambda_id": "string",
"lambda_name": "first-lambda",
"description": "very useful lambda",
"version": 5,
"info": {"status": "running",
"pod_statuses": {"0": "running",
"1": "waiting"
}
},
"lambda_type": "standalone",
"create_time": "2019-08-24T14:15:22Z",
"last_update_time": "2018-08-11T09:11:41.674Z",
"additional_user_docker_commands": [ ],
"base_image": {"name": "string",
"tag": "string"
},
"workers": 1,
"deploy_parameters": {"gpu_enabled": 0,
"pod_count": 2,
"resources": {"cpu_limit": 1000,
"ram_limit": 1,
"cpu_request": 1000,
"ram_request": 1
},
"namespace": "string",
"selector": {"app": "lambda-name"
}
}
}
]
}

get lambda

Get lambda by ID.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"account_id": "0468ca85-f6ca-4841-b30c-5ccc26b6f397",
"lambda_id": "string",
"lambda_name": "first-lambda",
"description": "very useful lambda",
"version": 5,
"info": {"status": "running",
"pod_statuses": {"0": "running",
"1": "waiting"
}
},
"lambda_type": "standalone",
"create_time": "2019-08-24T14:15:22Z",
"last_update_time": "2018-08-11T09:11:41.674Z",
"additional_user_docker_commands": [ ],
"base_image": {"name": "string",
"tag": "string"
},
"workers": 1,
"deploy_parameters": {"gpu_enabled": 0,
"pod_count": 2,
"resources": {"cpu_limit": 1000,
"ram_limit": 1,
"cpu_request": 1000,
"ram_request": 1
},
"namespace": "string",
"selector": {"app": "lambda-name"
}
}
}

check lambda existence

Check existence of the lambda by ID.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

400
404
500

Content type

application/json

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'account_id'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

get lambda status

Get lambda status by ID.

If lambda image creation is in progress, lambda status will be waiting.

For more information about lambda and lambda images statuses see development manual.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"status": "running",
"pod_statuses": {"0": "running",
"1": "waiting"
}
}

get lambda logs

Get lambda logs by ID.

After lambda creation has been executed, there is possibility to get lambda logs.

For more information about lambda and lambda images logs see development manual.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
tail_lines	integer [ 0 .. 4294967296 ] number of strings what will be return.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"logs": { }
}

lambdas validator

validation lambda

Lambda validation.

Lambda validation not guarantees hassle-free lambda creation and execution, but is an integral part of lambda creation process and allows you to make sure that the archive and its contents meet the requirements.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type required	string Value: "multipart/form-data" The request content type header.

Request Body schema: application/zip

archive required	string <binary> Archive file with zip extension. Content-Type must be "application/zip".
required	object Parameters for lambda.

Responses

Response samples

400
500

Content type

application/json

{"errors": ["validation_error_one",
"validation_error_two"
]
}

lambdas deletion

delete lambda

Remove lambda by ID.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

400
404
500

Content type

application/json

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'account_id'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

lambda update

update lambda

update lambda using latest base image.

The luna-platform update may cause incompatibility with old lambdas. To make the old lambdas compatible with actual luna-platform it needs to update lambda. For more details see development manual.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"version": 5
}

lambda image monitoring

get lambda image creation status

Get lambda image creation status by lambda ID.

If lambda image creation is in progress, lambda status will be waiting.

After lambda image creation will end, the lambda image creation job will be removed and status will be not_found.

For more information about lambda and lambda images statuses see development manual.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"status": "not_found"
}

get lambda image creation logs

Get lambda image creation logs by lambda ID.

During the creation of the lambda image, it is possible to get logs to monitor the progress.

For more information about lambda and lambda images logs see development manual.

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

query Parameters

tail_lines

integer [ 0 .. 4294967296 ]

number of strings what will be return.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"logs": ["string"
]
}

lambda documentation

get lambda openapi documentation

Get lambda OpenApi documentation. If Accept request header is of type application/x-yaml, returns documentation in yaml format or returns html documentation, if Accept-Type is text/html

path Parameters

lambda_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the lambda.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Accept required	string (accept_docs_handler) Enum: "application/x-yaml" "text/html" acceptable type of receiving data

Responses

Response samples

404
415
500

Content type

application/json

{"error_code": 42001,
"desc": "Object not found",
"detail": "Lambda with id 'e63e2a1f-f505-441c-8e11-b2dcd0385329' not found",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12013"
}

lambda proxy

proxy post request to lambda

Proxy POST request to lambda.

Request and response headers, query parameters and body description must be provided by lambda documentation.

Described headers will be processed and received independently of lambda behavior.

Note: proxy request

path Parameters

lambda_id required	string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515 ID of the lambda.
path_parameters	string Example: /main any additional path parameter will be use as path parameter to lambda

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Responses

Response samples

403
404
415
500

Content type

application/json

{"error_code": 11055,
"desc": "Forbidden",
"detail": "License problem: 'License expired'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11055"
}

proxy get request to lambda

Proxy GET request to lambda.

Request and response headers, query parameters and body description must be provided by lambda documentation.

Described headers will be processed and received independently of lambda behavior.

path Parameters

lambda_id required	string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515 ID of the lambda.
path_parameters	string Example: /main any additional path parameter will be use as path parameter to lambda

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

403
404
415
500

Content type

application/json

{"error_code": 11055,
"desc": "Forbidden",
"detail": "License problem: 'License expired'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11055"
}

proxy head request to lambda

Proxy HEAD request to lambda.

Request and response headers, query parameters and body description must be provided by lambda documentation.

Described headers will be processed and received independently of lambda behavior.

path Parameters

lambda_id required	string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515 ID of the lambda.
path_parameters	string Example: /main any additional path parameter will be use as path parameter to lambda

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

403
404
415
500

Content type

application/json

{"error_code": 11055,
"desc": "Forbidden",
"detail": "License problem: 'License expired'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11055"
}

proxy put request to lambda

Proxy PUT request to lambda.

Request and response headers, query parameters and body description must be provided by lambda documentation.

Described headers will be processed and received independently of lambda behavior.

path Parameters

lambda_id required	string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515 ID of the lambda.
path_parameters	string Example: /main any additional path parameter will be use as path parameter to lambda

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Responses

Response samples

403
404
415
500

Content type

application/json

{"error_code": 11055,
"desc": "Forbidden",
"detail": "License problem: 'License expired'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11055"
}

proxy patch request to lambda

Proxy PATCH request to lambda.

Request and response headers, query parameters and body description must be provided by lambda documentation.

Described headers will be processed and received independently of lambda behavior.

path Parameters

lambda_id required	string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515 ID of the lambda.
path_parameters	string Example: /main any additional path parameter will be use as path parameter to lambda

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

403
404
415
500

Content type

application/json

{"error_code": 11055,
"desc": "Forbidden",
"detail": "License problem: 'License expired'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11055"
}

proxy delete request to lambda

Proxy DELETE request to lambda.

Request and response headers, query parameters and body description must be provided by lambda documentation.

Described headers will be processed and received independently of lambda behavior.

path Parameters

lambda_id required	string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515 ID of the lambda.
path_parameters	string Example: /main any additional path parameter will be use as path parameter to lambda

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

403
404
415
500

Content type

application/json

{"error_code": 11055,
"desc": "Forbidden",
"detail": "License problem: 'License expired'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11055"
}

proxy options request to lambda

Proxy OPTIONS request to lambda.

Request and response headers, query parameters and body description must be provided by lambda documentation.

Described headers will be processed and received independently of lambda behavior.

path Parameters

lambda_id required	string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515 ID of the lambda.
path_parameters	string Example: /main any additional path parameter will be use as path parameter to lambda

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

404
415
500

Content type

application/json

Example

lambda_not_found

{"error_code": 42001,
"desc": "Object not found",
"detail": "Lambda with id 'e63e2a1f-f505-441c-8e11-b2dcd0385329' not found",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12013"
}

documents

get openapi documentation

Get service OpenApi documentation. If Accept request header is of type application/x-yaml, returns documentation in yaml format or returns html documentation, if Accept-Type is text/html

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Accept required	string (accept_docs_handler) Enum: "application/x-yaml" "text/html" acceptable type of receiving data

Responses

Response samples

415
500

Content type

application/json

{"error_code": 12024,
"detail": "Bad/incomplete input data",
"desc": "Unsupported media type",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12024"
}

get development manual

Get sphinx documentation - Development Manual. After the request you will be redirected to the page /docs/dev/index.html

header Parameters

Accept	string Value: "application/json" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

{"error_code": 1,
"detail": "internal server error",
"desc": "internal server error",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-1"
}

config

get service configuration

Get service configuration. Passwords and tokens will be hidden in the response.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Accept	string Enum: "application/json" "text/plain" acceptable type of receiving data

Responses

Response samples

200
415
500

Content type

application/json

{"INFLUX_MONITORING": {"SEND_DATA_FOR_MONITORING": 0,
"VERSION": 2,
"ORGANIZATION": "ORGANIZATION_NAME",
"TOKEN": "********",
"BUCKET": "luna_monitoring",
"HOST": "127.0.0.1",
"PORT": 8086,
"USE_SSL": 0,
"FLUSHING_PERIOD": 1
}
}

plugins

get list of plugins

Get list of service plugins

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500

Content type

application/json

{"plugins": [{"name": "foo",
"running": 1
}
]
}

metrics

get service requests statistics

Get statistics of success and failed requests to the service in prometheus format.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
403
500

Content type

text/plain

# HELP request_count_total Counter of requests
# TYPE request_count_total counter
request_count_total{path="GET:/healthcheck",status_code="200"} 1.0

health

get health

get health of service

query Parameters

include_luna_services

integer

Default: 0

Enum: 0 1

Whether to perform healthchecks for dependent luna services.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500
502

Content type

application/json

{"execution_time": 0.123
}