Luna-Licenses (v.0.11.6)

Download OpenAPI specification:Download

VisionLabs Luna Licenses.

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

version

get version

Get service version.

header Parameters

Luna-Request-Id

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

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

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

Responses

Response samples

200
500

Content type

application/json

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

documents

get docs

Get service documentation.

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

license

get license

Get license data:

license expiration date (expiration_time)
maximum number of faces with linked descriptor or basic attributes (faces_limit)
liveness feature availability (liveness)
current number of Liveness transactions (liveness_balance)
maximum number of streams created by the LUNA Streams service (streams_limit)
image check according to ISO/IEC 19794-5 standard availability (iso)
using the Index Matcher service in the LUNA Index Module availability (index)
body attributes estimation availability (body_attributes)
people counter estimation availability (people_counter)
lambdas availability (lambdas)

query Parameters

targets

string

Default: "expiration_time,faces_limit,liveness,iso,index,people_counter,body_attributes,streams_limit,lambdas"

Example: targets=expiration_time,faces_limit

Comma-separated list of face target fields. Available targets: expiration_time, faces_limit, liveness, iso, index, people_counter, body_attributes, streams_limit, lambdas

header Parameters

Luna-Request-Id

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

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

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

Responses

Response samples

200
400
500

Content type

application/json

{"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": 1000
},
"streams_limit": {"is_available": true,
"value": 10
},
"analytics_streams_limit": {"is_available": true,
"value": 10
},
"iso": {"is_available": true,
"value": 1
},
"index": {"is_available": true,
"value": 1
},
"body_attributes": {"is_available": true,
"value": 1
},
"people_counter": {"is_available": true,
"value": 1
},
"lambdas": {"is_available": true,
"value": 1
},
"deepfake": {"is_available": true,
"value": 1
}
}

executions consumption

Consume executions for the given features.

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.

Request Body schema: application/json

required

object

Liveness feature.

Responses

Request samples

Payload

Content type

application/json

{"liveness": {"execution_count": 200
}
}

Response samples

200
400
500

Content type

application/json

Example

success

{"liveness": {"result": {"error_code": 0,
"detail": "Success",
"desc": "Success",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-0"
},
"consumed_executions": 1
}
}

config

get service configuration

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

header Parameters

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

Responses

Response samples

200
415
500

Content type

application/json

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

plugins

get list of plugins

Get list of service plugins

header Parameters

Luna-Request-Id

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

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

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

Responses

Response samples

200
500

Content type

application/json

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

metrics

get service requests statistics

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

header Parameters

Luna-Request-Id

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

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

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

Responses

Response samples

200
403
500

Content type

text/plain

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

health

get health

Get health of service.

query Parameters

include_luna_services

integer

Default: 0

Enum: 0 1

Whether to perform healthchecks for dependent luna services.

header Parameters

Luna-Request-Id

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

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

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

Responses

Response samples

200
500
502

Content type

application/json

{"execution_time": 0.123
}