Sentinel Hub · Schema

Link

Satellite ImageryGeospatialRemote SensingEarth ObservationNDVISentinelLandsatMODISOGCSTAC

Properties

Name Type Description
href string The location of the resource
rel string Relation type of the link
type string The media type of the resource
title string Title of the resource
method string Specifies the HTTP method that the resource expects
headers object Object key values pairs they map to headers
body object For POST requests, the resource can specify the HTTP body as a JSON object.
merge boolean This is only valid when the server is responding to POST request. If merge is true, the client is expected to merge the body value into the current request body before following the link. This avoids
View JSON Schema on GitHub

JSON Schema

CatalogLink.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.sentinel-hub.com/schemas/CatalogLink",
  "title": "Link",
  "type": "object",
  "required": [
    "href",
    "rel"
  ],
  "properties": {
    "href": {
      "type": "string",
      "format": "uri",
      "description": "The location of the resource"
    },
    "rel": {
      "type": "string",
      "description": "Relation type of the link"
    },
    "type": {
      "type": "string",
      "description": "The media type of the resource"
    },
    "title": {
      "type": "string",
      "description": "Title of the resource"
    },
    "method": {
      "type": "string",
      "enum": [
        "GET",
        "POST"
      ],
      "default": "GET",
      "description": "Specifies the HTTP method that the resource expects"
    },
    "headers": {
      "type": "object",
      "description": "Object key values pairs they map to headers",
      "example": {
        "Accept": "application/json"
      }
    },
    "body": {
      "type": "object",
      "description": "For POST requests, the resource can specify the HTTP body as a JSON object."
    },
    "merge": {
      "type": "boolean",
      "default": false,
      "description": "This is only valid when the server is responding to POST request.\n\nIf merge is true, the client is expected to merge the body value\ninto the current request body before following the link.\nThis avoids passing large post bodies back and forth when following\nlinks, particularly for navigating pages through the `POST /search`\nendpoint.\n\nNOTE: To support form encoding it is expected that a client be able\nto merge in the key value pairs specified as JSON\n`{\"next\": \"token\"}` will become `&next=token`."
    }
  }
}