Get Vrt Status

GET

/datasets/{dataset_id}/vrt/status/

const url = 'https://example.com/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/vrt/status/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/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

Parameters

Path Parameters

dataset_id

required

Dataset Id

string format: uuid

Responses

200

Successful Response

application/json

VrtStatusResponse

object

active_generation

Any of:

VrtActiveGeneration
null

VrtActiveGeneration

object

elapsed_seconds

required

Elapsed Seconds

number

generation_id

required

Generation Id

string format: uuid

started_at

required

Started At

string format: date-time

last_generation_at

Any of:

string
null

string format: date-time

source_count

required

Source Count

integer

source_health

required

Source Health

Array<object>

VrtSourceHealth

object

dataset_id

required

Dataset Id

string format: uuid

status

required

Status

string

Allowed values: healthy missing inaccessible

title

required

Title

string

status

required

Status

string

Allowed values: ready regenerating failed

Example

{
  "source_health": [
    {
      "status": "healthy"
    }
  ],
  "status": "ready"
}

400

Bad request — invalid payload

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Unauthorized — missing or invalid credentials

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Forbidden — caller lacks write access

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Not found

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

409

Conflict — resource state prevents the operation

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Validation error

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Too many requests — retry after the advertised interval

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Retry-After

integer

Seconds until the request may be retried

500

Internal server error

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Service unavailable — the database could not serve the request

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}