Zarr Import API Reference

• Zarr Import API
  • Collection
    • postCreate a Zarr collection
    • getQuery Zarr collections
    • getGet a Zarr collection
    • putUpdate Zarr collection
    • delDelete Zarr collection
    • putReingest a Zarr collection
  • Arrays
    • getQuery Zarr collection's arrays
    • getGet a single Zarr array

API docs by Redocly

API Reference (1.0.0)

Download OpenAPI specification:Download

This page contains the documentation on how to use sentinel hub services through API calls.

Note: This documentation is not complete

Collection

Create a Zarr collection

Authorizations:

OAuth2

Request Body schema: application/json

name required	string
s3Bucket required	string The S3 bucket where the Zarr is stored.
path required	string The prefix within the bucket where the Zarr is stored. Must end with '/' but not start with it and must contain a Zarr group.
crs required	string Native CRS of the Zarr. See also Sentinel Hub CRS support.

Responses

https://services.sentinel-hub.com/api/v1/zarr/collections

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "s3Bucket": "string",
• "path": "string",
• "crs": "string",
• "envelope": {

  • "type": "Polygon",
  • "coordinates": [

    • [

      • [

        • 0.1,
        • 0.1

        ]

      ]

    ]

  }

}

Response samples

• 201
• 400
• 404

Content type

application/json

{

• "data": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "s3Bucket": "string",
  • "path": "string",
  • "status": "CREATED",
  • "ingestionErrors": "string",
  • "crs": "string",
  • "envelope": {

    • "type": "Polygon",
    • "coordinates": [

      • [

        • [

          • 0.1,
          • 0.1

          ]

        ]

      ]

    },
  • "width": 0,
  • "height": 0,
  • "zattrs": { },
  • "additionalData": {

    • "bands": {

      • "band1": {

        • "source": "string",
        • "bandIndex": 1,
        • "bitDepth": 8,
        • "sampleFormat": "UINT",
        • "noData": 0,
        • "aliases": [

          • "string"

          ]

        },
      • "band2": {

        • "source": "string",
        • "bandIndex": 1,
        • "bitDepth": 8,
        • "sampleFormat": "UINT",
        • "noData": 0,
        • "aliases": [

          • "string"

          ]

        }

      },
    • "maxMetersPerPixel": 0

    }

  }

}

Query Zarr collections

Authorizations:

OAuth2

query Parameters

count	integer <int32> Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use viewtoken to page through.
viewtoken	string When the total number of items is larger than count, the response contains viewtoken. This viewtoken can be used in the next request to retrieve the next page of items. The next page can be retrieved by repeating the query. However, replace your URL with the next URL in the returned links object.
search	string Optional query to search Zarr collections by name. If omitted, all items are returned.

Responses

https://services.sentinel-hub.com/api/v1/zarr/collections

Response samples

• 200

Content type

aplication/json

{

• "data": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
    • "name": "string",
    • "created": "2019-08-24T14:15:22Z",
    • "s3Bucket": "string",
    • "path": "string",
    • "status": "CREATED",
    • "ingestionErrors": "string",
    • "crs": "string",
    • "envelope": {

      • "type": "Polygon",
      • "coordinates": [

        • [

          • [

            • 0.1,
            • 0.1

            ]

          ]

        ]

      },
    • "width": 0,
    • "height": 0,
    • "zattrs": { },
    • "additionalData": {

      • "bands": {

        • "band1": {

          • "source": "string",
          • "bandIndex": 1,
          • "bitDepth": 8,
          • "sampleFormat": "UINT",
          • "noData": 0,
          • "aliases": [

            • "string"

            ]

          },
        • "band2": {

          • "source": "string",
          • "bandIndex": 1,
          • "bitDepth": 8,
          • "sampleFormat": "UINT",
          • "noData": 0,
          • "aliases": [

            • "string"

            ]

          }

        },
      • "maxMetersPerPixel": 0

      }

    }

  ]

}

Get a Zarr collection

Authorizations:

OAuth2

path Parameters

collectionId required

string <uuid>

Responses

https://services.sentinel-hub.com/api/v1/zarr/collections/{collectionId}

Response samples

• 200
• 404

Content type

application/json

{

• "data": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "s3Bucket": "string",
  • "path": "string",
  • "status": "CREATED",
  • "ingestionErrors": "string",
  • "crs": "string",
  • "envelope": {

    • "type": "Polygon",
    • "coordinates": [

      • [

        • [

          • 0.1,
          • 0.1

          ]

        ]

      ]

    },
  • "width": 0,
  • "height": 0,
  • "zattrs": { },
  • "additionalData": {

    • "bands": {

      • "band1": {

        • "source": "string",
        • "bandIndex": 1,
        • "bitDepth": 8,
        • "sampleFormat": "UINT",
        • "noData": 0,
        • "aliases": [

          • "string"

          ]

        },
      • "band2": {

        • "source": "string",
        • "bandIndex": 1,
        • "bitDepth": 8,
        • "sampleFormat": "UINT",
        • "noData": 0,
        • "aliases": [

          • "string"

          ]

        }

      },
    • "maxMetersPerPixel": 0

    }

  }

}

Update Zarr collection

Authorizations:

OAuth2

path Parameters

collectionId required

string <uuid>

Request Body schema: application/json

name required

string

Responses

https://services.sentinel-hub.com/api/v1/zarr/collections/{collectionId}

Request samples

• Payload

Content type

application/json

{

• "name": "string"

}

Response samples

• 400
• 404

Content type

application/json

{

• "error": {

  • "status": 0,
  • "reason": "string",
  • "message": "string",
  • "code": "COMMON_BAD_PAYLOAD",
  • "errors": { }

  }

}

Delete Zarr collection

Authorizations:

OAuth2

path Parameters

collectionId required

string <uuid>

Responses

https://services.sentinel-hub.com/api/v1/zarr/collections/{collectionId}

Response samples

• 404

Content type

application/json

{

• "error": {

  • "status": 0,
  • "reason": "string",
  • "message": "string",
  • "code": "COMMON_BAD_PAYLOAD",
  • "errors": { }

  }

}

Reingest a Zarr collection

Authorizations:

OAuth2

path Parameters

collectionId required

string <uuid>

Responses

https://services.sentinel-hub.com/api/v1/zarr/collections/{collectionId}/reingest

Response samples

• 200
• 404

Content type

application/json

{

• "data": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "s3Bucket": "string",
  • "path": "string",
  • "status": "CREATED",
  • "ingestionErrors": "string",
  • "crs": "string",
  • "envelope": {

    • "type": "Polygon",
    • "coordinates": [

      • [

        • [

          • 0.1,
          • 0.1

          ]

        ]

      ]

    },
  • "width": 0,
  • "height": 0,
  • "zattrs": { },
  • "additionalData": {

    • "bands": {

      • "band1": {

        • "source": "string",
        • "bandIndex": 1,
        • "bitDepth": 8,
        • "sampleFormat": "UINT",
        • "noData": 0,
        • "aliases": [

          • "string"

          ]

        },
      • "band2": {

        • "source": "string",
        • "bandIndex": 1,
        • "bitDepth": 8,
        • "sampleFormat": "UINT",
        • "noData": 0,
        • "aliases": [

          • "string"

          ]

        }

      },
    • "maxMetersPerPixel": 0

    }

  }

}

Arrays

Query Zarr collection's arrays

Authorizations:

OAuth2

path Parameters

collectionId required

string <uuid>

query Parameters

count	integer <int32> Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use viewtoken to page through.
viewtoken	string When the total number of items is larger than count, the response contains viewtoken. This viewtoken can be used in the next request to retrieve the next page of items. The next page can be retrieved by repeating the query. However, replace your URL with the next URL in the returned links object.
search	string Optional query to search arrays by name. If omitted, all items are returned.

Responses

https://services.sentinel-hub.com/api/v1/zarr/collections/{collectionId}/arrays

Response samples

• 200
• 404

Content type

application/json

{

• "data": [

  • {

    • "name": "string",
    • "s3Bucket": "string",
    • "path": "string",
    • "zarray": { },
    • "zattrs": { }

    }

  ]

}

Get a single Zarr array

Authorizations:

OAuth2

path Parameters

collectionId required	string <uuid>
arrayName required	string

Responses

https://services.sentinel-hub.com/api/v1/zarr/collections/{collectionId}/arrays/{arrayName}

Response samples

• 200
• 404

Content type

application/json

{

• "data": {

  • "name": "string",
  • "s3Bucket": "string",
  • "path": "string",
  • "zarray": { },
  • "zattrs": { }

  }

}