Changelog

Canopy API Changelog

📘

This Changelog is updated weekly on Tuesday before 4pm ET with all releases from the previous week.

[1.9.0] - 2024-01-23

Fixed

[1.8.0] - 2023-12-05

Added

Fixed

  • Sandbox Collects now have a duration of ~10s, occurring at the beginning of the parent Task window.
    • This replaces the old behavior where Sandbox Collect length was always the entire length of the parent Task window
    • This allows for more realistic tasking workflows and allows Collects to begin transitioning past SCHEDULED up to days earlier than before

[1.7.0] - 2023-11-07

Added

[1.6.2] - 2023-10-24

Changed

[1.6.1] - 2023-10-18

Added

[1.6.0] - 2023-09-19

Added

  • Added sicdXmlMetadata: bool = False option to Post Delivery Config. If True, the SICD XML Metadata will be rendered and delivered alongside the Umbra Collect Metadata json file with suffix ending _SICD-METADATA.xml

Changed

  • Create Task rate limits increased to 2/second, 120/min, 120/hour

Fixed

  • Fixed an issue that led to some file transfers failing when sent to S3 buckets in GovCloud
  • Fixed an issue that could lead to 500 errors when querying Get Organization Settings
  • Fixed an issue where Get Collect geometries, collect times, and collect properties would not update correctly if a Collect is moved on the spacecraft Schedule

[1.5.1] - 2023-09-05

Fixed

[1.5.0] - 2023-08-29

Added

[1.4.0] - 2023-08-22

Added

  • Added Get Organization Settings which can be used to programmatically retrieve the settings applied to a user's Canopy Organization

Fixed

  • Fixed an issue where status_history field was not available within the Developer Sandbox

[1.3.3] - 2023-08-15

Changed

  • In accordance with the updated Terms of Umbra's NOAA License, Umbra no longer performs resolution checks for any customer Collects before delivering them. In practice, this means that all requested product types for a given Collect will be delivered regardless of requested range resolution.

Fixed

  • Fixed an issue where re-delivery of images from our Archive would send the incorrect metadata file
  • Fixed the incorrectly stated rate limits for Create Feasibility in the Rate Limiting documentation

[1.3.2] - 2023-08-08

Changed

  • Increased rate limits on Create Task, Create Feasibility, and Cancel Task. Please review the updated rate limits table for these endpoints at Rate Limiting.
  • When retrieving access tokens via the Client Credentials workflow, https://auth.canopy.umbra.space/oauth/token will now return HTTP status code 400 instead of 500 when rate limiting is in effect. Please review the documentation here for more details.
  • Improved documentation for all enumerations associated with the Task and Feasibility models in the API Reference

Fixed

  • DeliveryConfig path interpolation for S3_UMBRA_ROLE configs will now replace Task.userOrderId = None with an empty string in the path rather than the string "None"

[1.3.1] - 2023-07-21

Fixed

  • Terrain elevation value calculated during Task creation now uses WGS84 model instead of EGM96 Create Task

[1.3.0] - 2023-07-11

Added

Fixed

[1.2.0] - 2023-06-27

Added

Changed

  • Increased SpotlightConstraints.grazingAngleMinDegrees maximum value from 69 to 74
  • Padded Opportunity.windowStartAt and Opportunity.windowEndAt results by five minutes each to avoid unnecessarily rejected Tasks due to small adjustments by the Umbra Scheduler

Fixed

[1.1.0] - 2023-06-20

Added

  • Added Collects API to allow search and direct retrieval of Collect information.
    • :warning: This release deprecates usage of the STAC Items in the STAC API for Collect status and history information.
  • Added Restricted Access Areas API to allow retrieval of locations where Tasking is disallowed for your Canopy organization.
  • Added Client Credentials API to allow customer self service of their organization's Machine to Machine token. Credentials can be created, retrieved, rotated, and deleted.
  • Added DeliveryConfig.options.isLegacyPathPrefix field for S3UmbraRole configurations. All new DeliveryConfigs should leave this option False unless otherwise specifically instructed by Canopy customer support.

Fixed

  • Improved validation for SpotlightConstraints.rangeResolutionMinMeters
  • Improved validation for SpotlightConstraints.multilookFactor
  • Collect.azimuthResolutionMinMeters now reports the correct value for Collects created after 2023-06-20
  • Collect.rangeResolutionMinMeters now reports the correct value for Collects created after 2023-06-20

[1.0.0] - 2023-06-13

Added

  • Added Changelog to Canopy API Documentation