Luna-Admin API (v.5.0.3)

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".

Authentication

BasicAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

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
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
401
500
504

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
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
401
500
504

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

200
401
500

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
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
401
500
504

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
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
401
500
504

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
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
401
500
504

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
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
401
500
504

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

200
500

Content type

application/json

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

help

get system info

get luna system info

Authorizations:

BasicAuth

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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
401
500
504

Content type

application/json

{"services_versions": {"luna-admin": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-accounts": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-sender": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-image-store-task-results": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-events": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-tasks": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-faces": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-image-store-faces-samples": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-image-store-bodies-samples": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-image-store-images": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-api": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-configurator": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-handlers": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-python-matcher": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-matcher-proxy": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"luna-licenses": {"api": 1,
"major": 2,
"minor": 3,
"patch": 4
},
"LUNA PLATFORM": {"major": 2,
"minor": 3,
"patch": 4
}
},
"descriptor_info": [{"descriptor_version": 56,
"descriptor_count": 1
}
],
"configs": [{"id": 34,
"tags": ["tag1",
"tag2"
],
"name": "SAVE_EVENTS_TIMEOUT",
"value": 2,
"description": "save events timeout. 0 or negative means no timeout",
"create_time": "2018-07-11T09:11:41.674Z",
"last_update_time": "2018-07-11T09:11:41.674Z",
"is_default": true
}
],
"current_faces_attributes_count": 10,
"license_info": {"expiration_time": {"is_available": true,
"value": "2021-08-11T09:11:41.674Z"
},
"faces_limit": {"is_available": true,
"value": 1000
},
"liveness": {"is_available": true,
"value": 1
},
"liveness_balance": {"is_available": true,
"value": 100000
},
"streams_limit": {"is_available": true,
"value": 1000
},
"iso": {"is_available": true,
"value": 1
},
"body_attributes": {"is_available": true,
"value": 1
},
"index": {"is_available": true,
"value": 1
},
"people_counter": {"is_available": true,
"value": 1
}
},
"signature": "string",
"stats": {"estimators_stats": [{"count": 1,
"month": "2021-09",
"name": "body_descriptor_extractor_usages"
}
],
"routes_stats": [{"service": "luna-api",
"route": "GET:/version",
"month": "2021-09",
"errors": [{"count": 1,
"error_code": "12012"
}
],
"request_stats": [{"count": 1,
"status_code": "200"
}
]
}
]
}
}

login

check authorization

check authorization cookie

Authorizations:

BasicAuth

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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

201
401
500

Content type

text/plain

Ok

set authorization

set authorization cookie

Authorizations:

BasicAuth

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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

401
500

Content type

application/json

Example

{"error_code": 12010,
"desc": "Bad/incomplete input data",
"detail": "This resource needs 'Authorization' authorization headers",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12010"
}

change authorization

change authorization cookie

Authorizations:

BasicAuth

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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 <= 128 characters

a new password.

Responses

Request samples

Payload

Content type

application/json

{"password": "password"
}

Response samples

400
401
500
504

Content type

application/json

{"error_code": 12002,
"desc": "Bad/incomplete input data",
"detail": "Request does not contain json",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12002"
}

clear authorization

clear authorization cookie

Authorizations:

BasicAuth

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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

401
404
500

Content type

application/json

Example

{"error_code": 12010,
"desc": "Bad/incomplete input data",
"detail": "This resource needs 'Authorization' authorization headers",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12010"
}

search

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
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
401
500
504

Content type

application/json

Example

{"data": {"info": {"account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"email": "horns@hooves.com",
"organization_name": "Horns and Hooves"
},
"stats": {"list_count": 1,
"face_count": 1,
"face_attribute_count": 1
}
},
"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.

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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
401
500

Content type

application/json

{"accounts": [{"account_id": "string",
"account_type": "advanced_user",
"description": "Horns and Hooves",
"login": "horns@hooves.com",
"email": "horns@hooves.com",
"organization_name": "Horns and Hooves"
}
],
"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
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 Account password.
description	string (account_description) <= 128 characters Default: "" Account description.

Responses

Request samples

Payload

Content type

application/json

Example

{"account_type": "advanced_user",
"login": "horns@hooves.com",
"password": "secret",
"description": "Horns and Hooves"
}

Response samples

201
400
401
409
500

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
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
401
404
500

Content type

application/json

{"info": {"account_id": "string",
"account_type": "advanced_user",
"description": "Horns and Hooves",
"login": "horns@hooves.com",
"email": "horns@hooves.com",
"organization_name": "Horns and Hooves"
},
"stats": {"list_count": 0,
"face_count": 0,
"face_attribute_count": 0
}
}

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
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 Account password.
description	string (account_description) <= 128 characters Default: "" Account description.

Responses

Request samples

Payload

Content type

application/json

Example

{"account_type": "advanced_user",
"login": "horns@hooves.com",
"password": "secret",
"description": "Horns and Hooves"
}

Response samples

200
400
401
409
500

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
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

401
500

Content type

application/json

Example

{"error_code": 12010,
"desc": "Bad/incomplete input data",
"detail": "This resource needs 'Authorization' authorization headers",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12010"
}

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
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
401
500
504

Content type

application/json

{"lists": [{"list_id": "string",
"account_id": "string",
"last_update_time": "string",
"face_count": 0,
"user_data": "string"
}
],
"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
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
401
404
500
504

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

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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": [{"task_id": 123,
"create_time": "string",
"end_time": "string",
"last_update_time": "string",
"task_type": 3,
"task_status": 1,
"result_id": "string",
"count_task_parts_done": 10,
"count_task_parts_all": 100,
"content": {"target": "face_descriptors",
"filters": {"descriptor_version": 0
}
},
"description": "string"
}
]
}

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

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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
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_id": 123,
"create_time": "string",
"end_time": "string",
"last_update_time": "string",
"task_type": 3,
"task_status": 1,
"result_id": "string",
"count_task_parts_done": 10,
"count_task_parts_all": 100,
"content": {"target": "face_descriptors",
"filters": {"descriptor_version": 0
}
},
"description": "string"
}

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
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

{"error_code": 28019,
"desc": "Bad/incomplete input data",
"detail": "Task '55023' with status 5 cannot be canceled",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-28019"
}

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
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

{"error_code": 28019,
"desc": "Bad/incomplete input data",
"detail": "Task '55023' with status 5 cannot be canceled",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-28019"
}

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
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

{"property1": null,
"property2": null
}

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
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

{"errors": [{"error_id": 0,
"task_id": 123,
"subtask_id": 5,
"error_code": 12010,
"description": "Faces not found",
"detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12010",
"error_time": "string",
"additional_info": "string"
}
]
}

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
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

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
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": [{"subtask_id": 5,
"task_id": 123,
"result_id": "string",
"create_time": "string",
"end_time": "string",
"subtask_status": 2,
"content": {"property1": null,
"property2": null
}
}
]
}

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
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

{"errors": [{"error_id": 0,
"task_id": 123,
"subtask_id": 5,
"error_code": 12010,
"description": "Faces not found",
"detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12010",
"error_time": "string",
"additional_info": "string"
}
]
}

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
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

Authorizations:

BasicAuth

path Parameters

error_id

required

integer (error_id)

error id

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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

{"error_id": 0,
"task_id": 123,
"subtask_id": 5,
"error_code": 12010,
"description": "Faces not found",
"detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12010",
"error_time": "string",
"additional_info": "string"
}

create gc task

create and start gc task

Authorizations:

BasicAuth

header Parameters

Authorization	string Example: Basic dGVzdHVzZXI6dGVzdHB3ZA== base64 user:password string
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

description	string provided user data for current task
required	any (GcTaskContent)

Responses

Request samples

Payload

Content type

application/json

{"description": "gc task one",
"content": {"target": "face_descriptors",
"filters": {"descriptor_version": 0
}
}
}

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
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

description	string provided user data for current task.
required	any (AdditionalExtractTaskContent) additional extract task.

Responses

Request samples

Payload

Content type

application/json

{"description": "clustering usefull faces",
"content": {"extraction_target": "basic_attributes",
"options": {"missing": true
},
"filters": {"objects_type": "faces",
"account_id": "string",
"face_id__lt": "string",
"face_id__gte": "string"
}
}
}

Response samples

Content type

application/json

{"task_id": 123
}

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

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

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

500

Content type

application/json

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

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

200
415
500

Content type

{"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
}
}

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

200
500
502
504

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

200
500
502
504

Content type

application/json

{"execution_time": 0.123
}