Skip to content
getgeolens.com
GeoLens Docs

Get Vrt Status

GET
/datasets/{dataset_id}/vrt/status/
 
curl --request GET \
  --url https://example.com/api/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/vrt/status/ \
  --header 'Authorization: Bearer <token>'

Return VRT dataset status, last generation time, source count, and per-source health.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
dataset_id
required
Dataset Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
VrtStatusResponse
object
status
required
Status
string
Allowed values: ready regenerating failed
last_generation_at
Any of:
string format: date-time
source_count
required
Source Count
integer
active_generation
Any of:
VrtActiveGeneration
object
generation_id
required
Generation Id
string format: uuid
started_at
required
Started At
string format: date-time
elapsed_seconds
required
Elapsed Seconds
number
source_health
required
Source Health
Array<object>
VrtSourceHealth
object
dataset_id
required
Dataset Id
string format: uuid
title
required
Title
string
status
required
Status
string
Allowed values: healthy missing inaccessible
Example 
{
  "status": "ready",
  "source_health": [
    {
      "status": "healthy"
    }
  ]
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}