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:
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".
account info form. if authorization is not passed redirection to /login page occurs
| 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. |
<html><body>some content</body></html>
version form.
| 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. |
<html><body>some content</body></html>
authorization form. if authorization is passed redirection to home page occurs
| 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. |
<html><body>some content</body></html>
account info form
| 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. |
<html><body>some content</body></html>
specified account info form
| 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 |
| 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. |
<html><body>some content</body></html>
specified account lists form
| 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 |
| 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. |
<html><body>some content</body></html>
task info form
| 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. |
<html><body>some content</body></html>
get versions of luna service
| 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. |
{- "api": 3,
- "major": 2,
- "minor": 0,
- "patch": 1
}get luna system info
| 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. |
{- "services_versions": {
- "luna-admin": {
- "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-indexed-matcher": {
- "luna-sdk-version": {
- "major": 2,
- "minor": 3,
- "patch": 4
}, - "api": 1,
- "major": 2,
- "minor": 3,
- "patch": 4
}, - "luna-index-manager": {
- "api": 1,
- "major": 2,
- "minor": 3,
- "patch": 4
}, - "luna-indexer": {
- "luna-sdk-version": {
- "major": 2,
- "minor": 3,
- "patch": 4
}, - "api": 1,
- "major": 2,
- "minor": 3,
- "patch": 4
}, - "luna-licenses": {
- "api": 1,
- "major": 2,
- "minor": 3,
- "patch": 4
}, - "liveness": "1.11.0",
- "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
}
}, - "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"
}
]
}
]
}
}check authorization cookie
| 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. |
Ok
set authorization cookie
| 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. |
{- "error_code": 12010,
- "desc": "Bad/incomplete input data",
- "detail": "This resource needs 'Authorization' authorization headers",
}change authorization cookie
| 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. |
| password | string <= 128 characters a new password. |
{- "password": "password"
}{- "error_code": 12002,
- "desc": "Bad/incomplete input data",
- "detail": "Request does not contain json",
}clear authorization cookie
| 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. |
{- "error_code": 12010,
- "desc": "Bad/incomplete input data",
- "detail": "This resource needs 'Authorization' authorization headers",
}search element by id or email
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. |
| 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. |
{- "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"
}get accounts with filters
| page | integer >= 1 Default: 1 Example: page=146 a page number. |
| page_size | integer [ 1 .. 100 ] Default: 10 Example: page_size=146 the number of items on page. |
| 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. |
{- "accounts": [
- {
- "account_id": "string",
- "email": "horns@hooves.com",
- "organization_name": "Horns and Hooves"
}
], - "account_count": 0
}register a new account in the system
| 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" |
| email required | string <email> (email) <= 64 characters ^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-... email address. |
| organization_name required | string (organization_name) <= 128 characters organization name. |
{- "email": "horns@hooves.com",
- "organization_name": "Horns and Hooves"
}{- "account_id": "string"
}get account info by account id
| 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 |
| 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. |
{- "info": {
- "account_id": "string",
- "email": "horns@hooves.com",
- "organization_name": "Horns and Hooves"
}, - "stats": {
- "list_count": 0,
- "face_count": 0,
- "face_attribute_count": 0
}
}register a new account with specified id in the system
| 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 |
| 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" |
| email required | string <email> (email) <= 64 characters ^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-... email address. |
| organization_name required | string (organization_name) <= 128 characters organization name. |
{- "email": "horns@hooves.com",
- "organization_name": "Horns and Hooves"
}{- "account_id": "string"
}remove the account with specified id from the system
| 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 |
| 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. |
{- "error_code": 12010,
- "desc": "Bad/incomplete input data",
- "detail": "This resource needs 'Authorization' authorization headers",
}get lists with filters
| page | integer >= 1 Default: 1 Example: page=146 a page number. |
| page_size | integer [ 1 .. 100 ] 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 |
| 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. |
{- "lists": [
- {
- "list_id": "string",
- "account_id": "string",
- "last_update_time": "string",
- "face_count": 0,
- "user_data": "string"
}
], - "list_count": 0
}get list info by id
| 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 |
| 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. |
{- "list_id": "string",
- "account_id": "string",
- "last_update_time": "string",
- "face_count": 0,
- "user_data": "string"
}get tasks with filters
| page | integer >= 1 Default: 1 Example: page=146 a page number. | ||||||||||||||||||||||
| page_size | integer [ 1 .. 100 ] 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_status | integer (task_status) Enum: 0 1 2 3 4 5 Example: task_status=1 task status.
|
| 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. |
{- "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
| 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_status | integer (task_status) Enum: 0 1 2 3 4 5 Example: task_status=1 task status.
|
| 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. |
{- "count": 40
}get task by id with filters
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| 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. |
{- "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 with filters
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| 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. |
{- "error_code": 28019,
- "desc": "Bad/incomplete input data",
- "detail": "Task '55023' with status 5 cannot be canceled",
}delete task by id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| 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. |
{- "error_code": 28019,
- "desc": "Bad/incomplete input data",
- "detail": "Task '55023' with status 5 cannot be canceled",
}get task result by id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| 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. |
{- "property1": null,
- "property2": null
}get task errors by task id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| page | integer >= 1 Default: 1 Example: page=146 a page number. |
| page_size | integer [ 1 .. 100 ] Default: 10 Example: page_size=146 the number of items on page. |
| 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. |
{- "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'",
- "error_time": "string",
- "additional_info": "string"
}
]
}get task error count by task id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| 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. |
| 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. |
{- "count": 5
}get subtasks by task id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| 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. |
{- "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
| page | integer >= 1 Default: 1 Example: page=146 a page number. | ||||||||||||||||||||||
| page_size | integer [ 1 .. 100 ] 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
| ||||||||||||||||||||||
| error_code | integer (error_code) Example: error_code=12010 error code. |
| 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. |
{- "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'",
- "error_time": "string",
- "additional_info": "string"
}
]
}get error count
| 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
| ||||||||||||||||||||||
| error_code | integer (error_code) Example: error_code=12010 error code. |
| 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. |
{- "count": 5
}get error by id
| error_id required | integer (error_id) error id |
| 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. |
{- "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'",
- "error_time": "string",
- "additional_info": "string"
}create and start gc task
| 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. |
| description | string provided user data for current task |
required | any (GcTaskContent) |
{- "description": "gc task one",
- "content": {
- "target": "face_descriptors",
- "filters": {
- "descriptor_version": 0
}
}
}{- "task_id": 123
}create and start additional extract task
| 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. |
| description | string provided user data for current task. |
required | any (AdditionalExtractTaskContent) additional extract task. |
{- "description": "clustering usefull faces",
- "content": {
- "extraction_target": "basic_attributes",
- "options": {
- "missing": true
}, - "filters": {
- "objects_type": "face",
- "account_id": "string",
- "face_id__lt": "string",
- "face_id__gte": "string"
}
}
}{- "task_id": 123
}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
| 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 |
{- "error_code": 12024,
- "detail": "Bad/incomplete input data",
- "desc": "Unsupported media type",
}Get sphinx documentation - Development Manual. After the request you will be redirected to the page /docs/dev/index.html
| 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. |
{- "error_code": 11009,
- "detail": "Internal server error",
- "desc": "Internal server error",
}Get service configuration. Passwords and tokens will be hidden in the 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. |
| Accept | string Enum: "application/json" "text/plain" acceptable type of receiving data |
{- "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
}
}get health of service
| include_luna_services | integer Default: 0 Enum: 0 1 whether to perform healthchecks for dependent luna services. |
| 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. |
{- "execution_time": 0.123
}get health of service (redirect)
| include_luna_services | integer Default: 0 Enum: 0 1 whether to perform healthchecks for dependent luna services. |
| 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. |
{- "execution_time": 0.123
}