API docs by Redocly

Luna-Admin API (v.5.7.22)

Download OpenAPI specification:Download

VisionLabs Luna Admin API.

OpenAPI specification is the only valid document providing up-to-date information about the service API.

The specification can be used:

  • By documentation generation tools to visualize the API.
  • By code generation tools.

All the documents and code generated using this specification can include inaccuracies and should be carefully checked.

OpenAPI specification can be received using the "/docs/spec" resource. The "Accept" header should be set to "application/x-yaml".

views

get account info tables

account info form. if authorization is not passed redirection to /login page occurs

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
text/html
<html><body>some content</body></html>

view version

version form.

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
text/html
<html><body>some content</body></html>

log in

authorization form. if authorization is passed redirection to home page occurs

Authorizations:
BasicAuth
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

Content type
text/html
<html><body>some content</body></html>

get account info tables

account info form

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
text/html
<html><body>some content</body></html>

get account info by id

specified account info form

Authorizations:
BasicAuth
path Parameters
account_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

account id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
text/html
<html><body>some content</body></html>

get account lists

specified account lists form

Authorizations:
BasicAuth
path Parameters
account_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

account id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
text/html
<html><body>some content</body></html>

get task info tables

task info form

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
text/html
<html><body>some content</body></html>

version

get version

get versions of luna service

Authorizations:
BasicAuth
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

Content type
application/json
{
  • "Version": {
    }
}

help

get system info

get luna system info

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "services_versions": {
    },
  • "descriptor_info": [
    ],
  • "configs": [
    ],
  • "current_faces_attributes_count": 10,
  • "license_info": {
    },
  • "signature": "string",
  • "stats": {
    }
}

login

check authorization

check authorization cookie

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
text/plain
Ok

set authorization

set authorization cookie

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
Example
{}

change authorization

change authorization cookie

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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"
Request Body schema: application/json
password
string [ 1 .. 128 ] characters ^.{1,128}$

a new password.

Responses

Request samples

Content type
application/json
{
  • "password": "password"
}

Response samples

Content type
application/json
{}

clear authorization

clear authorization cookie

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
Example
{}

search

search element by id or email

search element by id or email

Authorizations:
BasicAuth
query Parameters
id (string) or email (string)
Example: q=557d54ec-29ad-4f3c-93b4-c9092ef12515

specify the id of an element or the e-mail of an account.

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
Example
{
  • "data": {
    },
  • "type": "account"
}

accounts

get accounts

get accounts with filters

Authorizations:
BasicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=146

a page number.

page_size
integer [ 1 .. 1000 ]
Default: 10
Example: page_size=146

the number of items on page.

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:10:41.674Z

lower included bound for object create_time.

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "accounts": [
    ],
  • "account_count": 0
}

register account

register a new account in the system.

WARNING: Account registering with email is deprecated. Create accounts with login & password instead. When creating an account using legacy scheme, the email field will be used as login & password, and the organization_name field will be used as account description. Mind the validation errors.

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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"
Request Body schema: application/json
One of
account_type
string (account_type)
Default: "advanced_user"
Enum: "admin" "advanced_user" "user"

Account type.

login
required
string (login) [ 3 .. 128 ] characters ^[a-z0-9_'\+\-\.]+@[a-z0-9]+\.[a-z]{2,}$

Account username.

password
required
string (password) [ 3 .. 128 ] characters ^.{3,128}$

Account password.

description
string (account_description) <= 128 characters
Default: ""

Account description.

Responses

Request samples

Content type
application/json
Example
{
  • "account_type": "admin",
  • "login": "horns@hooves.com",
  • "password": "secret",
  • "description": "Horns and Hooves"
}

Response samples

Content type
application/json
{
  • "account_id": "string"
}

get account by id

get account info by account id

Authorizations:
BasicAuth
path Parameters
account_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

account id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "info": {
    },
  • "stats": {
    }
}

put account by id

register a new account with specified id in the system.

WARNING: Account registering with email is deprecated. Create accounts with login & password instead. When creating an account using legacy scheme, the email field will be used as login & password, and the organization_name field will be used as account description. Mind the validation errors.

Authorizations:
BasicAuth
path Parameters
account_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

account id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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"
Request Body schema: application/json
One of
account_type
string (account_type)
Default: "advanced_user"
Enum: "admin" "advanced_user" "user"

Account type.

login
required
string (login) [ 3 .. 128 ] characters ^[a-z0-9_'\+\-\.]+@[a-z0-9]+\.[a-z]{2,}$

Account username.

password
required
string (password) [ 3 .. 128 ] characters ^.{3,128}$

Account password.

description
string (account_description) <= 128 characters
Default: ""

Account description.

Responses

Request samples

Content type
application/json
Example
{
  • "account_type": "admin",
  • "login": "horns@hooves.com",
  • "password": "secret",
  • "description": "Horns and Hooves"
}

Response samples

Content type
application/json
{
  • "account_id": "string"
}

remove account by id

remove the account with specified id from the system

Authorizations:
BasicAuth
path Parameters
account_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

account id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
Example
{}

lists

get lists

get lists with filters

Authorizations:
BasicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=146

a page number.

page_size
integer [ 1 .. 1000 ]
Default: 10
Example: page_size=146

the number of items on page.

account_id
string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...
Example: account_id=557d54ec-29ad-4f3c-93b4-c9092ef12515
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "lists": [
    ],
  • "list_count": 0
}

get list

get list info by id

Authorizations:
BasicAuth
path Parameters
list_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

list id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "list_id": "string",
  • "account_id": "string",
  • "last_update_time": "string",
  • "face_count": 0,
  • "user_data": "string"
}

tasks

get tasks

get tasks with filters

Authorizations:
BasicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=146

a page number.

page_size
integer [ 1 .. 1000 ]
Default: 10
Example: page_size=146

the number of items on page.

task_ids
integer (task_id) >= 1
Example: task_ids=123

comma-separated task ids

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:10:41.674Z

lower included bound for object create_time.

end_time__lt
string <date-time> (time)
Example: end_time__lt=2018-08-11T10:11:41.674Z

upper bound for object end_time.

end_time__gte
string <date-time> (time)
Example: end_time__gte=2018-08-11T10:10:41.674Z

lower included bound for object end_time.

task_type
integer (task_type)
Enum: 0 1 2 3 4 5 6 7 8 9
Example: task_type=3

task type

task type value
unknown 0
linker 1
clusterization 2
report 3
garbage collect 4
additional extract 5
cross match 6
roc-curve calculation 7
export objects 8
estimate data 9
task_status
integer (task_status)
Enum: 0 1 2 3 4 5
Example: task_status=1

task status.

task status value
pending 0
in progress 1
cancelled 2
failed 3
collect results 4
done 5
schedule_id
integer (schedule_id) >= 1
Example: schedule_id=123

Schedule according to which the task was created

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "tasks": [
    ]
}

get task count

get task count

Authorizations:
BasicAuth
query Parameters
task_ids
integer (task_id) >= 1
Example: task_ids=123

comma-separated task ids

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:10:41.674Z

lower included bound for object create_time.

end_time__lt
string <date-time> (time)
Example: end_time__lt=2018-08-11T10:11:41.674Z

upper bound for object end_time.

end_time__gte
string <date-time> (time)
Example: end_time__gte=2018-08-11T10:10:41.674Z

lower included bound for object end_time.

task_type
integer (task_type)
Enum: 0 1 2 3 4 5 6 7 8 9
Example: task_type=3

task type

task type value
unknown 0
linker 1
clusterization 2
report 3
garbage collect 4
additional extract 5
cross match 6
roc-curve calculation 7
export objects 8
estimate data 9
task_status
integer (task_status)
Enum: 0 1 2 3 4 5
Example: task_status=1

task status.

task status value
pending 0
in progress 1
cancelled 2
failed 3
collect results 4
done 5
schedule_id
integer (schedule_id) >= 1
Example: schedule_id=123

Schedule according to which the task was created

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "count": 40
}

get task by id

get task by id with filters

Authorizations:
BasicAuth
path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
Example
{
  • "task_type": "1",
  • "content": {
    },
  • "task_id": 123,
  • "create_time": "2018-07-11T09:11:41.674Z",
  • "end_time": "2018-08-11T10:11:41.674Z",
  • "last_update_time": "2018-08-11T10:11:41.674Z",
  • "task_status": 1,
  • "result_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
  • "account_id": "string",
  • "count_task_parts_done": 10,
  • "count_task_parts_all": 100,
  • "description": "task description",
  • "notification_policy": {
    },
  • "result_storage_policy": {
    },
  • "schedule_id": 123
}

cancel task by id

cancel task by id with filters

Authorizations:
BasicAuth
path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{}

delete task by id

delete task by id

Authorizations:
BasicAuth
path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{}

get task notification policy

get task notification policy by task id

Authorizations:
BasicAuth
path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "enable": 1,
  • "task_callbacks": [
    ],
  • "subtask_callbacks": [
    ]
}

replace task notification policy

replace task notification policy by task id

Authorizations:
BasicAuth
path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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"
Request Body schema: application/json
enable
integer
Default: 1
Enum: 0 1

Whether callbacks enabled or not

Array of any (task_callbacks)

Callbacks for sending tasks id and status to third party system. Callbacks are executed after task status changed.

** Sample Output for successful task **

{"task_id": 123, "task_status": "done", "result_id": "00000000-0000-4000-a000-000000658854"}

** Sample Output for failed task **

{"task_id": 123, "task_status": "failed"}

** Sample Output for cancalled task **

{"task_id": 123, "task_status": "cancelled"}
Array of any (subtask_callbacks)

Callbacks for sending subtasks id, status and number of completed subtasks to third party system. Callbacks are executed after subtask status changed.

** Sample Output for start subtask **

{"subtask_id": 123, "subtask_status": "in_progress", "completed_subtasks": 0}

** Sample Output for successful subtask **

{"subtask_id": 123, "subtask_status": "done", "completed_subtasks": 0}

** Sample Output for failed subtask **

{"subtask_id": 123, "subtask_status": "failed", "completed_subtasks": 0}

** Sample Output for cancelled subtask **

{"subtask_id": 123, "subtask_status": "cancelled", "completed_subtasks": 0}

Responses

Request samples

Content type
application/json
{
  • "enable": 1,
  • "task_callbacks": [
    ],
  • "subtask_callbacks": [
    ]
}

Response samples

Content type
application/json
Example
{}

get task result by id

get task result by id

Authorizations:
BasicAuth
path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "task result fields1": null,
  • "task result fields2": null
}

get task errors by task id

get task errors by task id

Authorizations:
BasicAuth
path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

query Parameters
page
integer >= 1
Default: 1
Example: page=146

a page number.

page_size
integer [ 1 .. 1000 ]
Default: 10
Example: page_size=146

the number of items on page.

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{}

get task error count by task id

get task error count by task id

Authorizations:
BasicAuth
path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

query Parameters
error_time__lt
string <date-time> (time)
Example: error_time__lt=2018-08-11T09:11:41.674Z

upper bound for error time.

error_time__gte
string <date-time> (time)
Example: error_time__gte=2018-08-11T09:10:41.674Z

lower included bound for error_time.

error_code
integer (error_code)
Example: error_code=12010

error code.

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "count": 5
}

get subtasks by task id

get subtasks by task id

Authorizations:
BasicAuth
path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "subtasks": [
    ]
}

get errors

get errors

Authorizations:
BasicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=146

a page number.

page_size
integer [ 1 .. 1000 ]
Default: 10
Example: page_size=146

the number of items on page.

task_ids
integer (task_id) >= 1
Example: task_ids=123

comma-separated task ids

error_ids
string <comma-separate error ids> (error_ids) non-empty
Example: error_ids=4,5,6
error_time__lt
string <date-time> (time)
Example: error_time__lt=2018-08-11T09:11:41.674Z

upper bound for error time.

error_time__gte
string <date-time> (time)
Example: error_time__gte=2018-08-11T09:10:41.674Z

lower included bound for error_time.

task_type
integer (task_type)
Enum: 0 1 2 3 4 5 6 7 8 9
Example: task_type=3

task type

task type value
unknown 0
linker 1
clusterization 2
report 3
garbage collect 4
additional extract 5
cross match 6
roc-curve calculation 7
export objects 8
estimate data 9
error_code
integer (error_code)
Example: error_code=12010

error code.

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{}

get error count

get error count

Authorizations:
BasicAuth
query Parameters
task_ids
integer (task_id) >= 1
Example: task_ids=123

comma-separated task ids

error_ids
string <comma-separate error ids> (error_ids) non-empty
Example: error_ids=4,5,6
error_time__lt
string <date-time> (time)
Example: error_time__lt=2018-08-11T09:11:41.674Z

upper bound for error time.

error_time__gte
string <date-time> (time)
Example: error_time__gte=2018-08-11T09:10:41.674Z

lower included bound for error_time.

task_type
integer (task_type)
Enum: 0 1 2 3 4 5 6 7 8 9
Example: task_type=3

task type

task type value
unknown 0
linker 1
clusterization 2
report 3
garbage collect 4
additional extract 5
cross match 6
roc-curve calculation 7
export objects 8
estimate data 9
error_code
integer (error_code)
Example: error_code=12010

error code.

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "count": 5
}

get error by id

get error by id

Authorizations:
BasicAuth
path Parameters
error_id
required
integer (error_id)

error id

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{}

create gc task

create and start gc task

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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"
Request Body schema: application/json
required
any (gc_task_content)

gc task content

description
string

task description

object (notification_policy)

tasks processing notification policy

object (result_storage_policy)

tasks processing result storage policy

Responses

Request samples

Content type
application/json
{
  • "content": {
    },
  • "description": "string",
  • "notification_policy": {
    },
  • "result_storage_policy": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

create additional extract task

create and start additional extract task

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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"
Request Body schema: application/json
required
any (additional_extract_task_content)

additional extract task.

description
string

task description

object (notification_policy)

tasks processing notification policy

object (result_storage_policy)

tasks processing result storage policy

Responses

Request samples

Content type
application/json
{
  • "content": {
    },
  • "description": "string",
  • "notification_policy": {
    },
  • "result_storage_policy": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

schedules

create tasks schedule

Create a new task schedule.

Execution of scheduled tasks will be regulated according to the trigger and optionally starts one task immediately (see start_immediately parameter in behavior section)

No task from the schedule will be executed if the previous task has not yet been completed

Authorizations:
BasicAuth
header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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"
Request Body schema: application/json
required
any (task_schedulable)

task schedule

required
object (schedule_trigger)

task schedule trigger

object (schedule_behaviour)

schedule behaviour parameters

Responses

Request samples

Content type
application/json
{
  • "task": {
    },
  • "trigger": {
    },
  • "behaviour": {
    }
}

Response samples

Content type
application/json
{
  • "schedule_id": 123
}

get tasks schedules

get tasks schedules with filters

Authorizations:
BasicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=146

a page number.

page_size
integer [ 1 .. 1000 ]
Default: 10
Example: page_size=146

the number of items on page.

task_type
integer (task_type_schedulable_reply)
Enum: 1 2 3 4 5 6 7 8
Example: task_type=1

task type

task type value
linker 1
clusterization 2
report 3
garbage collect 4
additional extract 5
cross match 6
roc-curve calculation 7
export objects 8
estimator 9
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:10:41.674Z

lower included bound for object create_time.

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
[
  • {
    }
]

get tasks schedule

get tasks schedule

Authorizations:
BasicAuth
path Parameters
schedule_id
required
integer (schedule_id) >= 1
Example: 123

Schedule according to which the task was created

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{
  • "schedule_id": 123,
  • "task_ids": [
    ],
  • "task": {
    },
  • "trigger": {
    },
  • "status": "running",
  • "next_run_time": "2018-07-11T09:11:41.674Z",
  • "create_time": "2018-07-11T09:11:41.674Z",
  • "last_update_time": "2018-07-11T09:11:41.674Z"
}

replace tasks schedule

Replace tasks schedule:

  • if any task created by old schedule is running, it will be cancelled

  • schedule parameters will be replaced with the new ones

  • tasks will be executed according to the new schedule

Authorizations:
BasicAuth
path Parameters
schedule_id
required
integer (schedule_id) >= 1
Example: 123

Schedule according to which the task was created

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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"
Request Body schema: application/json
required
any (task_schedulable)

task schedule

required
object (schedule_trigger)

task schedule trigger

object (schedule_behaviour)

schedule behaviour parameters

Responses

Request samples

Content type
application/json
{
  • "task": {
    },
  • "trigger": {
    },
  • "behaviour": {
    }
}

Response samples

Content type
application/json
{
  • "schedule_id": 123
}

patch tasks schedule

pause/start tasks schedule

Authorizations:
BasicAuth
path Parameters
schedule_id
required
integer (schedule_id) >= 1
Example: 123

Schedule according to which the task was created

query Parameters
action
required
string
Enum: "pause" "start"

pause/start tasks schedule

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{}

delete tasks schedule

delete tasks schedule

Authorizations:
BasicAuth
path Parameters
schedule_id
required
integer (schedule_id) >= 1
Example: 123

Schedule according to which the task was created

header Parameters
Authorization
string
Example: Basic dGVzdHVzZXI6dGVzdHB3ZA==

base64 user:password string

Exclude-Header
string
Value: "WWW-Authorization"
Example: WWW-Authorization

Exclude header from response

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

Content type
application/json
{}

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

Authorizations:
BasicAuth
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

Content type
application/json
{}

get development manual

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

Authorizations:
BasicAuth
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

Content type
application/json
{}

config

get service configuration

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

Authorizations:
BasicAuth
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

Content type
{
  • "INFLUX_MONITORING": {
    }
}

health

get health

get health of service

Authorizations:
BasicAuth
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

Content type
application/json
{
  • "execution_time": 0.123
}

get health (redirect)

get health of service (redirect)

Authorizations:
BasicAuth
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

Content type
application/json
{
  • "execution_time": 0.123
}

plugins

get list of plugins

Get list of service plugins

Authorizations:
BasicAuth
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

Content type
application/json
{
  • "plugins": [
    ]
}

metrics

get service requests statistics

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

Authorizations:
BasicAuth
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

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