Datasets

Preview Service Layer

Preview a selected remote layer via ogrinfo and create a pending IngestJob.

Validates the URL against SSRF, builds the GDAL driver source string, runs ogrinfo to extract metadata and sample rows, then creates an IngestJob ready for the existing commit flow.

post/services/preview/

Request

The document declares no server URL.
Auth: one of:
- OAuth 2 (password, token URL /api/auth/login)
- API key in header X-Api-Key
- API key in query parameter api_key

Request body

urlstring required

Normalized service URL from a previous probe response.

service_typestring required

Service type from the probe response, e.g. 'WFS 2.0.0' or 'ArcGIS FeatureServer'.

layer_namestring required

Name of the specific layer to preview, from the probe layers list.

layer_titlestring nullable

Human-readable layer title from the probe LayerInfo.

tokenstring nullable

Optional auth token for protected services. Deprecated: use the auth object with method bearer.

object_id_fieldstring nullable

ArcGIS OID field name used for orderByFields during preview pagination.

Response

Successful Response

job_idstring uuid required

IngestJob ID for the preview. Use this to commit the import.

source_filenamestring nullable required

Layer name acting as a source filename for downstream ingestion logic.

columnsobject[] required

Detected attribute columns: [{'name': str, 'type': str}, ...].

crsinteger nullable required

Detected EPSG code for the layer's CRS.

geometry_typestring nullable required

Detected geometry type.

feature_countinteger nullable required

Total feature count if reported by the source service.

sample_rowsobject[] required

Up to 5 sample rows for preview display.

layer_namestring required

Layer name as it appears in the remote service.

Changes

No recorded changes to this operation across all 50 revisions of this API.