Sign in
Records

Create Distribution Endpoint

Create a manual distribution for a record.

post/records/{record_id}/distributions/

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

Path parameters

record_idstring uuid required

Request body

distribution_typestring required

e.g. download, api, ogc_wms, ogc_wfs

formatstring required

File or service format, e.g. GeoJSON, SHP, WMS

urlstring required

Access URL for this distribution

titlestring nullable
descriptionstring nullable
protocolstring nullable

Transfer protocol, e.g. HTTPS, OGC:WFS

media_typestring nullable

IANA media type, e.g. application/geo+json

is_primaryboolean

Mark as the preferred distribution

Response

Successful Response

idstring uuid required
record_idstring uuid required
distribution_typestring required
formatstring nullable required
urlstring required
titlestring nullable required
descriptionstring nullable required
protocolstring nullable required
media_typestring nullable required
is_primaryboolean required
auto_generatedboolean required

True if created automatically by the system

Changes

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