components: parameters: CompletedParameter: description: > Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples: * A date-time: \"2018-02-12T23:20:50Z\" * A closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" * Open intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\" Only subscriptions or results that have a completed timestamp that intersects the value of `completed` are selected. in: query name: completed schema: type: string CreatedParameter: description: > Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples: * A date-time: \"2018-02-12T23:20:50Z\" * A closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" * Open intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\" Only subscriptions or results that have a created timestamp that intersects the value of `created` are selected. in: query name: created schema: type: string EndTimeParameter: description: > Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples: * A date-time: \"2018-02-12T23:20:50Z\" * A closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" * Open intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\" Only subscriptions that have an end time that intersects the value of `end_time` are selected. in: query name: end_time schema: type: string FormatParameter: description: | The desired format for the response data. Defaults to JSON. Examples: * `format=csv` * `format=json` in: query name: format schema: enum: - csv - json type: string GeomRefParameter: description: > URI reference to a feature collection or individual feature in the Features API. Examples: * `geom_ref=pl:features/my/feature-collection` * `geom_ref=pl:features/my/feature-collection/feature-id` in: query name: geom_ref schema: type: string HostingParameter: description: > Only return subscriptions that contain a hosting block (e.g. Planet Insights Platform hosting). in: query name: hosting schema: type: boolean ItemDatetimeParameter: description: > Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples: * A date-time: \"2018-02-12T23:20:50Z\" * A closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" * Open intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\" Only subscriptions that have an item datetime that intersects the value of `item_datetime` are selected. in: query name: item_datetime schema: type: string NameContainsParameter: description: | Only return subscriptions with a name that contains the given string. in: query name: name__contains schema: type: string NameParameter: description: | Only return subscriptions with a name that matches the given string. in: query name: name schema: type: string PageMarkerDateParameter: in: query name: page_marker schema: format: date-time type: string PageMarkerParameter: in: query name: page_marker schema: type: string PageSizeParameter: in: query name: page_size schema: format: int32 maximum: 10000 minimum: 0 type: integer ResultsStatusParameter: in: query name: status schema: enum: - created - queued - processing - failed - success type: string SortByParameter: description: > Fields to sort subscriptions by. Multiple fields can be specified, separated by commas. The sort direction can be specified by appending ' ASC' or ' DESC' to the field name. The default sort direction is ascending. When multiple fields are specified, the sort order is applied in the order the fields are listed. If no `sort_by` parameter is provided, subscriptions will be sorted by `created DESC` by default. Supported fields: name, created, updated, start_time, end_time Examples: * `sort_by=name` * `sort_by=name DESC` * `sort_by=name,end_time DESC,start_time` in: query name: sort_by schema: type: string SourceTypeParameter: in: query name: source_type schema: $ref: '#/components/schemas/SourceTypesAll' StartTimeParameter: description: > Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples: * A date-time: \"2018-02-12T23:20:50Z\" * A closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" * Open intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\" Only subscriptions that have a start time that intersects the value of `start_time` are selected. in: query name: start_time schema: type: string StatusParameter: in: query name: status schema: enum: - running - cancelled - preparing - pending - completed - suspended - failed - invalid type: string UpdatedParameter: description: > Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples: * A date-time: \"2018-02-12T23:20:50Z\" * A closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" * Open intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\" Only subscriptions or results that have an updated timestamp that intersects the value of `updated` are selected. in: query name: updated schema: type: string UserIDExtendedParameter: description: > When set to `all`, returns information about subscriptions created by all users in the organization. When set to an integer that represents a user ID, only returns information about subscriptions created by that user in the organization. Only allowed if the calling user has sufficient permissions. in: query name: user_id schema: pattern: ^(all|[0-9]+)$ type: string UserIDParameter: description: > When set to `all`, returns information about subscriptions created by all users in the organization. Only allowed if the calling user has sufficient permissions. in: query name: user_id schema: enum: - all type: string schemas: AWSDeliverySimple: additionalProperties: false description: Amazon S3 destination details properties: parameters: additionalProperties: false properties: aws_access_key_id: description: S3 account access key. type: string aws_region: description: AWS region bucket resides in. type: string aws_secret_access_key: description: S3 account secret key. type: string bucket: description: S3 bucket to send results type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - aws_region - aws_access_key_id - aws_secret_access_key type: object type: enum: - amazon_s3 type: string required: - type - parameters title: AWS type: object AzureDeliverySimple: additionalProperties: false description: Azure blob storage details. properties: parameters: additionalProperties: false properties: account: description: Azure account. type: string container: description: Blob storage container name. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string sas_token: description: Shared-Access Signature token. type: string storage_endpoint_suffix: description: The storage endpoint suffix. type: string required: - account - container - sas_token type: object type: enum: - azure_blob_storage type: string required: - type - parameters title: Azure type: object CloudFilterParameters: additionalProperties: false anyOf: - required: - cloud_percent - required: - clear_percent - required: - shadow_percent - required: - snow_ice_percent - required: - heavy_haze_percent - required: - light_haze_percent properties: clear_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object cloud_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object heavy_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object light_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object shadow_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object snow_ice_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object type: object ConflictResponse: example: error: details: [] reason: Conflict properties: error: properties: details: items: {} type: array reason: example: Conflict type: string type: object type: object DataAPISourceParameters: additionalProperties: false description: Catalog source parameters based on imagery available in the Data API properties: asset_types: items: type: string minItems: 1 type: array end_time: format: date-time type: string filter: type: object geometry: type: object geometry_relation: description: > Specify the relationship between the subscription geometry and the item geometry. Intersects (default): Returns items whose footprint geometry partially or fully overlaps with the subscription geometry. Contains: Returns items where the footprint geometry fully encloses the AOI. Within: Returns items whose entire footprint geometry is fully contained within the AOI. type: string item_types: items: type: string minItems: 1 type: array publishing_stages: description: > Specify image publishing stages to receive; preview, standard, or finalized. If not specified, a default value will be determined based on the item-type of the subscription. PSScene: standard, finalized. SkySatCollect, SkySatScene, and SkySatVideo: finalized. Note that this parameter cannot be used with item-types that lack a publishing_stage metadata value (e.g., Sentinel2L1C). example: - standard - finalized items: type: string minItems: 1 type: array rrule: description: Recurrence rule (iCalendar RFC 5545) example: FREQ=MONTHLY;BYMONTH=3,4,5,6,7 type: string start_time: format: date-time type: string time_range_type: description: > Specify the date field in the image metadata to utilize for matching images within the subscription start and end time. Choose between the "published" date (when the image was made published to the catalog) or the "acquired" date (when the image was captured or collected). example: published type: string required: - item_types - asset_types title: DataAPISource Parameters type: object DeliveryPathPrefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string DestinationDeliverySimple: additionalProperties: false description: Delivery to a destination configured via Planet's Destinations API. properties: parameters: additionalProperties: false properties: path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string ref: description: >- pl:ref URI from a destination configured via Planet's Destinations API. type: string required: - ref type: object type: enum: - destination type: string required: - type - parameters title: Planet Destination type: object GCSDeliverySimple: additionalProperties: false description: Credentials and bucket for delivery to Google Cloud properties: parameters: additionalProperties: false properties: bucket: description: GCS bucket name. type: string credentials: description: JSON-string of service account for bucket. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - credentials type: object type: enum: - google_cloud_storage type: string required: - type - parameters title: GCS type: object GEEDeliverySimple: additionalProperties: false description: GEE delivery details properties: parameters: additionalProperties: false properties: collection: description: GEE Image Collection name. type: string credentials: description: JSON-string of service account for image collection. type: string project: description: GEE project name type: string required: - collection - credentials - project type: object type: enum: - google_earth_engine type: string required: - type - parameters title: GEE type: object NotificationTopics: enum: - delivery.success - delivery.match - delivery.failed - status.backfill.completed - status.completed - status.cancelled - status.pending - status.all - status.suspended - status.failed type: string OCSDeliverySimple: additionalProperties: false description: Oracle Cloud Storage destination details properties: parameters: additionalProperties: false properties: bucket: description: Oracle bucket to send results. type: string customer_access_key_id: description: Oracle account access key. type: string customer_secret_key: description: Oracle account secret key. type: string namespace: description: Oracle Object Storage namespace. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Oracle region bucket resides in. type: string required: - bucket - customer_access_key_id - customer_secret_key - region - namespace type: object type: enum: - oracle_cloud_storage type: string required: - type - parameters title: OCS type: object PercentageFilter: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object PermissionDeniedResponse: example: error: details: [] reason: Permission denied properties: error: properties: details: items: {} type: array reason: example: Permission denied type: string type: object type: object ResultStatuses: properties: created: type: integer failed: type: integer processing: type: integer queued: type: integer success: type: integer type: object ResultsResponse: properties: _links: properties: _next: description: >- RFC 3986 URI representing the location of the next page of results. Omitted when there are no results, or the current page is the last. type: string _self: description: RFC 3986 URI representing the location of this object. type: string type: object completed: format: date-time type: string created: format: date-time type: string errors: properties: details: items: type: string type: array reason: type: string type: object id: format: uuid type: string outputs: items: type: string type: array properties: type: object status: type: string updated: format: date-time type: string type: object S3CompatibleDeliverySimple: additionalProperties: false description: S3 compatible destination details properties: parameters: additionalProperties: false properties: access_key_id: description: Access key for authentication. type: string bucket: description: S3-compatible bucket to send results. type: string endpoint: description: S3-compatible service endpoint. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Region for the S3-compatible service. type: string secret_access_key: description: Secret key for authentication. type: string use_path_style: default: false description: Use path-style addressing with bucket name in URL. type: boolean required: - endpoint - bucket - region - access_key_id - secret_access_key type: object type: enum: - s3_compatible type: string required: - type - parameters title: S3 Compatible type: object SentinelHubHosting: additionalProperties: false description: Planet Insights Platform (formerly Sentinel Hub) hosting details. properties: parameters: additionalProperties: false properties: collection_id: description: > A data collection to deliver to. If omitted, a new collection will be created for you and returned in the response. Collections can be found on the [Planet Insights Platform](https://insights.planet.com/data/collections). format: uuid type: string configuration_id: description: | Specifies the ID of the layer configuration. - If `create_configuration` is enabled, this field will contain the ID of the newly created layer configuration. - Any provided value will be ignored. format: uuid type: string create_configuration: description: > Determines whether to automatically create a layer configuration for your collection. - The configuration will be assigned the same name as the collection. - If no compatible configuration is found, the operation will return an error. - The `collection_id` parameter cannot be specified when `create_configuration` is set to `true`. type: boolean type: object type: enum: - sentinel_hub type: string required: - type title: Planet Insights Platform Hosting type: object SourceTypes: enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string SourceTypesAll: oneOf: - enum: - catalog type: string - enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string SourceTypesCatalog: enum: - catalog type: string SourceTypesSubSource: enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string Subscription: properties: backfill_completed: description: Timestamp when backfill processing completed for this subscription format: date-time type: string created: format: date-time type: string delivery: oneOf: - additionalProperties: false description: Credentials and bucket for delivery to Google Cloud properties: parameters: additionalProperties: false properties: bucket: description: GCS bucket name. type: string credentials: description: JSON-string of service account for bucket. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - credentials type: object type: enum: - google_cloud_storage type: string required: - type - parameters title: GCS type: object - additionalProperties: false description: Amazon S3 destination details properties: parameters: additionalProperties: false properties: aws_access_key_id: description: S3 account access key. type: string aws_region: description: AWS region bucket resides in. type: string aws_secret_access_key: description: S3 account secret key. type: string bucket: description: S3 bucket to send results type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - aws_region - aws_access_key_id - aws_secret_access_key type: object type: enum: - amazon_s3 type: string required: - type - parameters title: AWS type: object - additionalProperties: false description: Azure blob storage details. properties: parameters: additionalProperties: false properties: account: description: Azure account. type: string container: description: Blob storage container name. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string sas_token: description: Shared-Access Signature token. type: string storage_endpoint_suffix: description: The storage endpoint suffix. type: string required: - account - container - sas_token type: object type: enum: - azure_blob_storage type: string required: - type - parameters title: Azure type: object - additionalProperties: false description: Oracle Cloud Storage destination details properties: parameters: additionalProperties: false properties: bucket: description: Oracle bucket to send results. type: string customer_access_key_id: description: Oracle account access key. type: string customer_secret_key: description: Oracle account secret key. type: string namespace: description: Oracle Object Storage namespace. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Oracle region bucket resides in. type: string required: - bucket - customer_access_key_id - customer_secret_key - region - namespace type: object type: enum: - oracle_cloud_storage type: string required: - type - parameters title: OCS type: object - additionalProperties: false description: GEE delivery details properties: parameters: additionalProperties: false properties: collection: description: GEE Image Collection name. type: string credentials: description: JSON-string of service account for image collection. type: string project: description: GEE project name type: string required: - collection - credentials - project type: object type: enum: - google_earth_engine type: string required: - type - parameters title: GEE type: object - additionalProperties: false description: S3 compatible destination details properties: parameters: additionalProperties: false properties: access_key_id: description: Access key for authentication. type: string bucket: description: S3-compatible bucket to send results. type: string endpoint: description: S3-compatible service endpoint. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Region for the S3-compatible service. type: string secret_access_key: description: Secret key for authentication. type: string use_path_style: default: false description: Use path-style addressing with bucket name in URL. type: boolean required: - endpoint - bucket - region - access_key_id - secret_access_key type: object type: enum: - s3_compatible type: string required: - type - parameters title: S3 Compatible type: object - additionalProperties: false description: >- Delivery to a destination configured via Planet's Destinations API. properties: parameters: additionalProperties: false properties: path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string ref: description: >- pl:ref URI from a destination configured via Planet's Destinations API. type: string required: - ref type: object type: enum: - destination type: string required: - type - parameters title: Planet Destination type: object type: object error_hints: description: >- An error object with a reason and details field. This field is present on failed, invalid, and suspended subscriptions. properties: details: items: {} type: array reason: example: Unexpected error type: string type: object id: format: uuid type: string name: description: Name of the subscription type: string notifications: description: Webhook notifications, if configured. properties: webhook: additionalProperties: false description: Set params for webhook notifications properties: topics: items: enum: - delivery.success - delivery.match - delivery.failed - status.backfill.completed - status.completed - status.cancelled - status.pending - status.all - status.suspended - status.failed type: string minItems: 1 type: array uniqueItems: true url: format: uri type: string required: - url - topics title: Webhook notification type: object type: object source: additionalProperties: false description: Source block to define the subscription source parameters properties: parameters: oneOf: - additionalProperties: false description: >- Catalog source parameters based on imagery available in the Data API properties: asset_types: items: type: string minItems: 1 type: array end_time: format: date-time type: string filter: type: object geometry: type: object geometry_relation: description: > Specify the relationship between the subscription geometry and the item geometry. Intersects (default): Returns items whose footprint geometry partially or fully overlaps with the subscription geometry. Contains: Returns items where the footprint geometry fully encloses the AOI. Within: Returns items whose entire footprint geometry is fully contained within the AOI. type: string item_types: items: type: string minItems: 1 type: array publishing_stages: description: > Specify image publishing stages to receive; preview, standard, or finalized. If not specified, a default value will be determined based on the item-type of the subscription. PSScene: standard, finalized. SkySatCollect, SkySatScene, and SkySatVideo: finalized. Note that this parameter cannot be used with item-types that lack a publishing_stage metadata value (e.g., Sentinel2L1C). example: - standard - finalized items: type: string minItems: 1 type: array rrule: description: Recurrence rule (iCalendar RFC 5545) example: FREQ=MONTHLY;BYMONTH=3,4,5,6,7 type: string start_time: format: date-time type: string time_range_type: description: > Specify the date field in the image metadata to utilize for matching images within the subscription start and end time. Choose between the "published" date (when the image was made published to the catalog) or the "acquired" date (when the image was captured or collected). example: published type: string required: - item_types - asset_types title: DataAPISource Parameters type: object - additionalProperties: false description: >- Sources for data resources beyond what is available in the Data API properties: end_time: format: date-time type: string geometry: type: object id: type: string start_time: format: date-time type: string required: - id - geometry - start_time title: SubscriptionSource Parameters type: object type: object type: oneOf: - enum: - catalog type: string - enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string required: - parameters title: Subscription Source type: object status: type: string tools: description: A list of blocks for processing items obtained from 'source'. items: anyOf: - additionalProperties: false description: Provide a clipping AOI for items. properties: parameters: additionalProperties: false properties: aoi: description: >- Providing a clip AOI is optional. When this parameter is omitted, the subscription geometry will be used (so long as the clip tool is still specified). type: object type: object type: enum: - clip type: string required: - type - parameters title: TransformClip type: object - additionalProperties: false description: Provide desired projection for imagery assets properties: parameters: additionalProperties: false properties: kernel: type: string projection: type: string resolution: format: float type: number required: - projection type: object type: enum: - reproject type: string required: - type - parameters title: TransformReproject type: object - additionalProperties: false description: Apply band math expressions to images properties: parameters: additionalProperties: false properties: b1: type: string b10: type: string b11: type: string b12: type: string b13: type: string b14: type: string b15: type: string b2: type: string b3: type: string b4: type: string b5: type: string b6: type: string b7: type: string b8: type: string b9: type: string pixel_type: type: string type: object type: enum: - bandmath type: string required: - type - parameters title: TransformBandmath type: object - additionalProperties: false description: >- Radiometrically harmonize imagery to a different sensor. Currently Sentinel-2 the only supported target sensor. properties: parameters: additionalProperties: false properties: target_sensor: type: string required: - target_sensor type: object type: enum: - harmonize type: string required: - type - parameters title: TransformHarmonize type: object - additionalProperties: false description: >- Convert analytic imagery products to top of atmosphere reflectance products properties: parameters: additionalProperties: false properties: scale_factor: default: 10000 type: integer type: object type: enum: - toar type: string required: - type - parameters title: TransformToar type: object - additionalProperties: false description: Convert imagery to Cloud Optimized GeoTIFF or NITF formats properties: parameters: additionalProperties: false properties: format: type: string required: - format type: object type: enum: - file_format type: string required: - type - parameters title: TransformFileFormat type: object type: array updated: format: date-time type: string type: object SubscriptionBulkCreateRequest: additionalProperties: false description: Subscription Bulk Create Request properties: subscriptions: description: List of subscriptions to bulk create items: additionalProperties: false properties: delivery: description: A delivery mechanism. oneOf: - additionalProperties: false description: Credentials and bucket for delivery to Google Cloud properties: parameters: additionalProperties: false properties: bucket: description: GCS bucket name. type: string credentials: description: JSON-string of service account for bucket. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - credentials type: object type: enum: - google_cloud_storage type: string required: - type - parameters title: GCS type: object - additionalProperties: false description: Amazon S3 destination details properties: parameters: additionalProperties: false properties: aws_access_key_id: description: S3 account access key. type: string aws_region: description: AWS region bucket resides in. type: string aws_secret_access_key: description: S3 account secret key. type: string bucket: description: S3 bucket to send results type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - aws_region - aws_access_key_id - aws_secret_access_key type: object type: enum: - amazon_s3 type: string required: - type - parameters title: AWS type: object - additionalProperties: false description: Azure blob storage details. properties: parameters: additionalProperties: false properties: account: description: Azure account. type: string container: description: Blob storage container name. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string sas_token: description: Shared-Access Signature token. type: string storage_endpoint_suffix: description: The storage endpoint suffix. type: string required: - account - container - sas_token type: object type: enum: - azure_blob_storage type: string required: - type - parameters title: Azure type: object - additionalProperties: false description: Oracle Cloud Storage destination details properties: parameters: additionalProperties: false properties: bucket: description: Oracle bucket to send results. type: string customer_access_key_id: description: Oracle account access key. type: string customer_secret_key: description: Oracle account secret key. type: string namespace: description: Oracle Object Storage namespace. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Oracle region bucket resides in. type: string required: - bucket - customer_access_key_id - customer_secret_key - region - namespace type: object type: enum: - oracle_cloud_storage type: string required: - type - parameters title: OCS type: object - additionalProperties: false description: GEE delivery details properties: parameters: additionalProperties: false properties: collection: description: GEE Image Collection name. type: string credentials: description: >- JSON-string of service account for image collection. type: string project: description: GEE project name type: string required: - collection - credentials - project type: object type: enum: - google_earth_engine type: string required: - type - parameters title: GEE type: object - additionalProperties: false description: S3 compatible destination details properties: parameters: additionalProperties: false properties: access_key_id: description: Access key for authentication. type: string bucket: description: S3-compatible bucket to send results. type: string endpoint: description: S3-compatible service endpoint. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Region for the S3-compatible service. type: string secret_access_key: description: Secret key for authentication. type: string use_path_style: default: false description: Use path-style addressing with bucket name in URL. type: boolean required: - endpoint - bucket - region - access_key_id - secret_access_key type: object type: enum: - s3_compatible type: string required: - type - parameters title: S3 Compatible type: object - additionalProperties: false description: >- Delivery to a destination configured via Planet's Destinations API. properties: parameters: additionalProperties: false properties: path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string ref: description: >- pl:ref URI from a destination configured via Planet's Destinations API. type: string required: - ref type: object type: enum: - destination type: string required: - type - parameters title: Planet Destination type: object type: object hosting: anyOf: - additionalProperties: false description: >- Planet Insights Platform (formerly Sentinel Hub) hosting details. properties: parameters: additionalProperties: false properties: collection_id: description: > A data collection to deliver to. If omitted, a new collection will be created for you and returned in the response. Collections can be found on the [Planet Insights Platform](https://insights.planet.com/data/collections). format: uuid type: string configuration_id: description: | Specifies the ID of the layer configuration. - If `create_configuration` is enabled, this field will contain the ID of the newly created layer configuration. - Any provided value will be ignored. format: uuid type: string create_configuration: description: > Determines whether to automatically create a layer configuration for your collection. - The configuration will be assigned the same name as the collection. - If no compatible configuration is found, the operation will return an error. - The `collection_id` parameter cannot be specified when `create_configuration` is set to `true`. type: boolean type: object type: enum: - sentinel_hub type: string required: - type title: Planet Insights Platform Hosting type: object description: > Specify a data hosting location. A hosting location removes the need to specify a delivery location. Specifying both is not allowed. This location cannot be updated after a subscription has been created. type: object name: description: Name of the subscription type: string notifications: description: Specify notifications via webhook. properties: webhook: additionalProperties: false description: Set params for webhook notifications properties: topics: items: enum: - delivery.success - delivery.match - delivery.failed - status.backfill.completed - status.completed - status.cancelled - status.pending - status.all - status.suspended - status.failed type: string minItems: 1 type: array uniqueItems: true url: format: uri type: string required: - url - topics title: Webhook notification type: object type: object source: additionalProperties: false description: Source block to define the subscription source parameters properties: parameters: oneOf: - additionalProperties: false description: >- Catalog source parameters based on imagery available in the Data API properties: asset_types: items: type: string minItems: 1 type: array end_time: format: date-time type: string filter: type: object geometry: type: object geometry_relation: description: > Specify the relationship between the subscription geometry and the item geometry. Intersects (default): Returns items whose footprint geometry partially or fully overlaps with the subscription geometry. Contains: Returns items where the footprint geometry fully encloses the AOI. Within: Returns items whose entire footprint geometry is fully contained within the AOI. type: string item_types: items: type: string minItems: 1 type: array publishing_stages: description: > Specify image publishing stages to receive; preview, standard, or finalized. If not specified, a default value will be determined based on the item-type of the subscription. PSScene: standard, finalized. SkySatCollect, SkySatScene, and SkySatVideo: finalized. Note that this parameter cannot be used with item-types that lack a publishing_stage metadata value (e.g., Sentinel2L1C). example: - standard - finalized items: type: string minItems: 1 type: array rrule: description: Recurrence rule (iCalendar RFC 5545) example: FREQ=MONTHLY;BYMONTH=3,4,5,6,7 type: string start_time: format: date-time type: string time_range_type: description: > Specify the date field in the image metadata to utilize for matching images within the subscription start and end time. Choose between the "published" date (when the image was made published to the catalog) or the "acquired" date (when the image was captured or collected). example: published type: string required: - item_types - asset_types title: DataAPISource Parameters type: object - additionalProperties: false description: >- Sources for data resources beyond what is available in the Data API properties: end_time: format: date-time type: string geometry: type: object id: type: string start_time: format: date-time type: string required: - id - geometry - start_time title: SubscriptionSource Parameters type: object type: object type: oneOf: - enum: - catalog type: string - enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string required: - parameters title: Subscription Source type: object tools: description: A list of blocks for processing items obtained from 'source'. items: anyOf: - additionalProperties: false description: Provide a clipping AOI for items. properties: parameters: additionalProperties: false properties: aoi: description: >- Providing a clip AOI is optional. When this parameter is omitted, the subscription geometry will be used (so long as the clip tool is still specified). type: object type: object type: enum: - clip type: string required: - type - parameters title: TransformClip type: object - additionalProperties: false description: Provide desired projection for imagery assets properties: parameters: additionalProperties: false properties: kernel: type: string projection: type: string resolution: format: float type: number required: - projection type: object type: enum: - reproject type: string required: - type - parameters title: TransformReproject type: object - additionalProperties: false description: Apply band math expressions to images properties: parameters: additionalProperties: false properties: b1: type: string b10: type: string b11: type: string b12: type: string b13: type: string b14: type: string b15: type: string b2: type: string b3: type: string b4: type: string b5: type: string b6: type: string b7: type: string b8: type: string b9: type: string pixel_type: type: string type: object type: enum: - bandmath type: string required: - type - parameters title: TransformBandmath type: object - additionalProperties: false description: >- Radiometrically harmonize imagery to a different sensor. Currently Sentinel-2 the only supported target sensor. properties: parameters: additionalProperties: false properties: target_sensor: type: string required: - target_sensor type: object type: enum: - harmonize type: string required: - type - parameters title: TransformHarmonize type: object - additionalProperties: false description: >- Convert analytic imagery products to top of atmosphere reflectance products properties: parameters: additionalProperties: false properties: scale_factor: default: 10000 type: integer type: object type: enum: - toar type: string required: - type - parameters title: TransformToar type: object - additionalProperties: false description: >- Convert imagery to Cloud Optimized GeoTIFF or NITF formats properties: parameters: additionalProperties: false properties: format: type: string required: - format type: object type: enum: - file_format type: string required: - type - parameters title: TransformFileFormat type: object - description: >- Filter imagery based on updated metadata values ("cloud_cover", "shadow_percent", "clear_percent", "snow_ice_percent", "heavy_haze_percent", "light_haze_percent") after a scene has been clipped to a provided AOI. This tool requires that the clip tool is also used. properties: parameters: additionalProperties: false anyOf: - required: - cloud_percent - required: - clear_percent - required: - shadow_percent - required: - snow_ice_percent - required: - heavy_haze_percent - required: - light_haze_percent properties: clear_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object cloud_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object heavy_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object light_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object shadow_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object snow_ice_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object type: object type: enum: - cloud_filter type: string required: - type - parameters title: TransformCloudFilter type: object type: array required: - name - source type: object type: array required: - subscriptions type: object SubscriptionBulkCreateResponse: properties: _links: properties: list: type: string type: object type: object SubscriptionBulkReactivateRequest: description: Subscription Bulk Reactivate Request properties: subscription_ids: description: List of subscription IDs to reactivate items: format: uuid type: string maxItems: 1000 minItems: 1 type: array required: - subscription_ids type: object SubscriptionBulkSuspendRequest: description: Subscription Bulk Suspend Request properties: details: description: Details about the suspension reason type: string subscription_ids: description: List of subscription IDs to suspend items: format: uuid type: string maxItems: 1000 minItems: 1 type: array type: object SubscriptionCreateRequest: additionalProperties: false description: Subscription Request properties: delivery: description: A delivery mechanism. oneOf: - additionalProperties: false description: Credentials and bucket for delivery to Google Cloud properties: parameters: additionalProperties: false properties: bucket: description: GCS bucket name. type: string credentials: description: JSON-string of service account for bucket. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - credentials type: object type: enum: - google_cloud_storage type: string required: - type - parameters title: GCS type: object - additionalProperties: false description: Amazon S3 destination details properties: parameters: additionalProperties: false properties: aws_access_key_id: description: S3 account access key. type: string aws_region: description: AWS region bucket resides in. type: string aws_secret_access_key: description: S3 account secret key. type: string bucket: description: S3 bucket to send results type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - aws_region - aws_access_key_id - aws_secret_access_key type: object type: enum: - amazon_s3 type: string required: - type - parameters title: AWS type: object - additionalProperties: false description: Azure blob storage details. properties: parameters: additionalProperties: false properties: account: description: Azure account. type: string container: description: Blob storage container name. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string sas_token: description: Shared-Access Signature token. type: string storage_endpoint_suffix: description: The storage endpoint suffix. type: string required: - account - container - sas_token type: object type: enum: - azure_blob_storage type: string required: - type - parameters title: Azure type: object - additionalProperties: false description: Oracle Cloud Storage destination details properties: parameters: additionalProperties: false properties: bucket: description: Oracle bucket to send results. type: string customer_access_key_id: description: Oracle account access key. type: string customer_secret_key: description: Oracle account secret key. type: string namespace: description: Oracle Object Storage namespace. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Oracle region bucket resides in. type: string required: - bucket - customer_access_key_id - customer_secret_key - region - namespace type: object type: enum: - oracle_cloud_storage type: string required: - type - parameters title: OCS type: object - additionalProperties: false description: GEE delivery details properties: parameters: additionalProperties: false properties: collection: description: GEE Image Collection name. type: string credentials: description: JSON-string of service account for image collection. type: string project: description: GEE project name type: string required: - collection - credentials - project type: object type: enum: - google_earth_engine type: string required: - type - parameters title: GEE type: object - additionalProperties: false description: S3 compatible destination details properties: parameters: additionalProperties: false properties: access_key_id: description: Access key for authentication. type: string bucket: description: S3-compatible bucket to send results. type: string endpoint: description: S3-compatible service endpoint. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Region for the S3-compatible service. type: string secret_access_key: description: Secret key for authentication. type: string use_path_style: default: false description: Use path-style addressing with bucket name in URL. type: boolean required: - endpoint - bucket - region - access_key_id - secret_access_key type: object type: enum: - s3_compatible type: string required: - type - parameters title: S3 Compatible type: object - additionalProperties: false description: >- Delivery to a destination configured via Planet's Destinations API. properties: parameters: additionalProperties: false properties: path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string ref: description: >- pl:ref URI from a destination configured via Planet's Destinations API. type: string required: - ref type: object type: enum: - destination type: string required: - type - parameters title: Planet Destination type: object type: object hosting: anyOf: - additionalProperties: false description: >- Planet Insights Platform (formerly Sentinel Hub) hosting details. properties: parameters: additionalProperties: false properties: collection_id: description: > A data collection to deliver to. If omitted, a new collection will be created for you and returned in the response. Collections can be found on the [Planet Insights Platform](https://insights.planet.com/data/collections). format: uuid type: string configuration_id: description: | Specifies the ID of the layer configuration. - If `create_configuration` is enabled, this field will contain the ID of the newly created layer configuration. - Any provided value will be ignored. format: uuid type: string create_configuration: description: > Determines whether to automatically create a layer configuration for your collection. - The configuration will be assigned the same name as the collection. - If no compatible configuration is found, the operation will return an error. - The `collection_id` parameter cannot be specified when `create_configuration` is set to `true`. type: boolean type: object type: enum: - sentinel_hub type: string required: - type title: Planet Insights Platform Hosting type: object description: > Specify a data hosting location. A hosting location removes the need to specify a delivery location. Specifying both is not allowed. This location cannot be updated after a subscription has been created. type: object name: description: Name of the subscription type: string notifications: description: Specify notifications via webhook. properties: webhook: additionalProperties: false description: Set params for webhook notifications properties: topics: items: enum: - delivery.success - delivery.match - delivery.failed - status.backfill.completed - status.completed - status.cancelled - status.pending - status.all - status.suspended - status.failed type: string minItems: 1 type: array uniqueItems: true url: format: uri type: string required: - url - topics title: Webhook notification type: object type: object source: additionalProperties: false description: Source block to define the subscription source parameters properties: parameters: oneOf: - additionalProperties: false description: >- Catalog source parameters based on imagery available in the Data API properties: asset_types: items: type: string minItems: 1 type: array end_time: format: date-time type: string filter: type: object geometry: type: object geometry_relation: description: > Specify the relationship between the subscription geometry and the item geometry. Intersects (default): Returns items whose footprint geometry partially or fully overlaps with the subscription geometry. Contains: Returns items where the footprint geometry fully encloses the AOI. Within: Returns items whose entire footprint geometry is fully contained within the AOI. type: string item_types: items: type: string minItems: 1 type: array publishing_stages: description: > Specify image publishing stages to receive; preview, standard, or finalized. If not specified, a default value will be determined based on the item-type of the subscription. PSScene: standard, finalized. SkySatCollect, SkySatScene, and SkySatVideo: finalized. Note that this parameter cannot be used with item-types that lack a publishing_stage metadata value (e.g., Sentinel2L1C). example: - standard - finalized items: type: string minItems: 1 type: array rrule: description: Recurrence rule (iCalendar RFC 5545) example: FREQ=MONTHLY;BYMONTH=3,4,5,6,7 type: string start_time: format: date-time type: string time_range_type: description: > Specify the date field in the image metadata to utilize for matching images within the subscription start and end time. Choose between the "published" date (when the image was made published to the catalog) or the "acquired" date (when the image was captured or collected). example: published type: string required: - item_types - asset_types title: DataAPISource Parameters type: object - additionalProperties: false description: >- Sources for data resources beyond what is available in the Data API properties: end_time: format: date-time type: string geometry: type: object id: type: string start_time: format: date-time type: string required: - id - geometry - start_time title: SubscriptionSource Parameters type: object type: object type: oneOf: - enum: - catalog type: string - enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string required: - parameters title: Subscription Source type: object tools: description: A list of blocks for processing items obtained from 'source'. items: anyOf: - additionalProperties: false description: Provide a clipping AOI for items. properties: parameters: additionalProperties: false properties: aoi: description: >- Providing a clip AOI is optional. When this parameter is omitted, the subscription geometry will be used (so long as the clip tool is still specified). type: object type: object type: enum: - clip type: string required: - type - parameters title: TransformClip type: object - additionalProperties: false description: Provide desired projection for imagery assets properties: parameters: additionalProperties: false properties: kernel: type: string projection: type: string resolution: format: float type: number required: - projection type: object type: enum: - reproject type: string required: - type - parameters title: TransformReproject type: object - additionalProperties: false description: Apply band math expressions to images properties: parameters: additionalProperties: false properties: b1: type: string b10: type: string b11: type: string b12: type: string b13: type: string b14: type: string b15: type: string b2: type: string b3: type: string b4: type: string b5: type: string b6: type: string b7: type: string b8: type: string b9: type: string pixel_type: type: string type: object type: enum: - bandmath type: string required: - type - parameters title: TransformBandmath type: object - additionalProperties: false description: >- Radiometrically harmonize imagery to a different sensor. Currently Sentinel-2 the only supported target sensor. properties: parameters: additionalProperties: false properties: target_sensor: type: string required: - target_sensor type: object type: enum: - harmonize type: string required: - type - parameters title: TransformHarmonize type: object - additionalProperties: false description: >- Convert analytic imagery products to top of atmosphere reflectance products properties: parameters: additionalProperties: false properties: scale_factor: default: 10000 type: integer type: object type: enum: - toar type: string required: - type - parameters title: TransformToar type: object - additionalProperties: false description: Convert imagery to Cloud Optimized GeoTIFF or NITF formats properties: parameters: additionalProperties: false properties: format: type: string required: - format type: object type: enum: - file_format type: string required: - type - parameters title: TransformFileFormat type: object - description: >- Filter imagery based on updated metadata values ("cloud_cover", "shadow_percent", "clear_percent", "snow_ice_percent", "heavy_haze_percent", "light_haze_percent") after a scene has been clipped to a provided AOI. This tool requires that the clip tool is also used. properties: parameters: additionalProperties: false anyOf: - required: - cloud_percent - required: - clear_percent - required: - shadow_percent - required: - snow_ice_percent - required: - heavy_haze_percent - required: - light_haze_percent properties: clear_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object cloud_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object heavy_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object light_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object shadow_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object snow_ice_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object type: object type: enum: - cloud_filter type: string required: - type - parameters title: TransformCloudFilter type: object type: array required: - name - source type: object SubscriptionPatchRequest: properties: name: description: Name of the subscription type: string required: - name SubscriptionResponse: allOf: - properties: backfill_completed: description: >- Timestamp when backfill processing completed for this subscription format: date-time type: string created: format: date-time type: string delivery: oneOf: - additionalProperties: false description: Credentials and bucket for delivery to Google Cloud properties: parameters: additionalProperties: false properties: bucket: description: GCS bucket name. type: string credentials: description: JSON-string of service account for bucket. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - credentials type: object type: enum: - google_cloud_storage type: string required: - type - parameters title: GCS type: object - additionalProperties: false description: Amazon S3 destination details properties: parameters: additionalProperties: false properties: aws_access_key_id: description: S3 account access key. type: string aws_region: description: AWS region bucket resides in. type: string aws_secret_access_key: description: S3 account secret key. type: string bucket: description: S3 bucket to send results type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - aws_region - aws_access_key_id - aws_secret_access_key type: object type: enum: - amazon_s3 type: string required: - type - parameters title: AWS type: object - additionalProperties: false description: Azure blob storage details. properties: parameters: additionalProperties: false properties: account: description: Azure account. type: string container: description: Blob storage container name. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string sas_token: description: Shared-Access Signature token. type: string storage_endpoint_suffix: description: The storage endpoint suffix. type: string required: - account - container - sas_token type: object type: enum: - azure_blob_storage type: string required: - type - parameters title: Azure type: object - additionalProperties: false description: Oracle Cloud Storage destination details properties: parameters: additionalProperties: false properties: bucket: description: Oracle bucket to send results. type: string customer_access_key_id: description: Oracle account access key. type: string customer_secret_key: description: Oracle account secret key. type: string namespace: description: Oracle Object Storage namespace. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Oracle region bucket resides in. type: string required: - bucket - customer_access_key_id - customer_secret_key - region - namespace type: object type: enum: - oracle_cloud_storage type: string required: - type - parameters title: OCS type: object - additionalProperties: false description: GEE delivery details properties: parameters: additionalProperties: false properties: collection: description: GEE Image Collection name. type: string credentials: description: JSON-string of service account for image collection. type: string project: description: GEE project name type: string required: - collection - credentials - project type: object type: enum: - google_earth_engine type: string required: - type - parameters title: GEE type: object - additionalProperties: false description: S3 compatible destination details properties: parameters: additionalProperties: false properties: access_key_id: description: Access key for authentication. type: string bucket: description: S3-compatible bucket to send results. type: string endpoint: description: S3-compatible service endpoint. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Region for the S3-compatible service. type: string secret_access_key: description: Secret key for authentication. type: string use_path_style: default: false description: Use path-style addressing with bucket name in URL. type: boolean required: - endpoint - bucket - region - access_key_id - secret_access_key type: object type: enum: - s3_compatible type: string required: - type - parameters title: S3 Compatible type: object - additionalProperties: false description: >- Delivery to a destination configured via Planet's Destinations API. properties: parameters: additionalProperties: false properties: path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string ref: description: >- pl:ref URI from a destination configured via Planet's Destinations API. type: string required: - ref type: object type: enum: - destination type: string required: - type - parameters title: Planet Destination type: object type: object error_hints: description: >- An error object with a reason and details field. This field is present on failed, invalid, and suspended subscriptions. properties: details: items: {} type: array reason: example: Unexpected error type: string type: object id: format: uuid type: string name: description: Name of the subscription type: string notifications: description: Webhook notifications, if configured. properties: webhook: additionalProperties: false description: Set params for webhook notifications properties: topics: items: enum: - delivery.success - delivery.match - delivery.failed - status.backfill.completed - status.completed - status.cancelled - status.pending - status.all - status.suspended - status.failed type: string minItems: 1 type: array uniqueItems: true url: format: uri type: string required: - url - topics title: Webhook notification type: object type: object source: additionalProperties: false description: Source block to define the subscription source parameters properties: parameters: oneOf: - additionalProperties: false description: >- Catalog source parameters based on imagery available in the Data API properties: asset_types: items: type: string minItems: 1 type: array end_time: format: date-time type: string filter: type: object geometry: type: object geometry_relation: description: > Specify the relationship between the subscription geometry and the item geometry. Intersects (default): Returns items whose footprint geometry partially or fully overlaps with the subscription geometry. Contains: Returns items where the footprint geometry fully encloses the AOI. Within: Returns items whose entire footprint geometry is fully contained within the AOI. type: string item_types: items: type: string minItems: 1 type: array publishing_stages: description: > Specify image publishing stages to receive; preview, standard, or finalized. If not specified, a default value will be determined based on the item-type of the subscription. PSScene: standard, finalized. SkySatCollect, SkySatScene, and SkySatVideo: finalized. Note that this parameter cannot be used with item-types that lack a publishing_stage metadata value (e.g., Sentinel2L1C). example: - standard - finalized items: type: string minItems: 1 type: array rrule: description: Recurrence rule (iCalendar RFC 5545) example: FREQ=MONTHLY;BYMONTH=3,4,5,6,7 type: string start_time: format: date-time type: string time_range_type: description: > Specify the date field in the image metadata to utilize for matching images within the subscription start and end time. Choose between the "published" date (when the image was made published to the catalog) or the "acquired" date (when the image was captured or collected). example: published type: string required: - item_types - asset_types title: DataAPISource Parameters type: object - additionalProperties: false description: >- Sources for data resources beyond what is available in the Data API properties: end_time: format: date-time type: string geometry: type: object id: type: string start_time: format: date-time type: string required: - id - geometry - start_time title: SubscriptionSource Parameters type: object type: object type: oneOf: - enum: - catalog type: string - enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string required: - parameters title: Subscription Source type: object status: type: string tools: description: A list of blocks for processing items obtained from 'source'. items: anyOf: - additionalProperties: false description: Provide a clipping AOI for items. properties: parameters: additionalProperties: false properties: aoi: description: >- Providing a clip AOI is optional. When this parameter is omitted, the subscription geometry will be used (so long as the clip tool is still specified). type: object type: object type: enum: - clip type: string required: - type - parameters title: TransformClip type: object - additionalProperties: false description: Provide desired projection for imagery assets properties: parameters: additionalProperties: false properties: kernel: type: string projection: type: string resolution: format: float type: number required: - projection type: object type: enum: - reproject type: string required: - type - parameters title: TransformReproject type: object - additionalProperties: false description: Apply band math expressions to images properties: parameters: additionalProperties: false properties: b1: type: string b10: type: string b11: type: string b12: type: string b13: type: string b14: type: string b15: type: string b2: type: string b3: type: string b4: type: string b5: type: string b6: type: string b7: type: string b8: type: string b9: type: string pixel_type: type: string type: object type: enum: - bandmath type: string required: - type - parameters title: TransformBandmath type: object - additionalProperties: false description: >- Radiometrically harmonize imagery to a different sensor. Currently Sentinel-2 the only supported target sensor. properties: parameters: additionalProperties: false properties: target_sensor: type: string required: - target_sensor type: object type: enum: - harmonize type: string required: - type - parameters title: TransformHarmonize type: object - additionalProperties: false description: >- Convert analytic imagery products to top of atmosphere reflectance products properties: parameters: additionalProperties: false properties: scale_factor: default: 10000 type: integer type: object type: enum: - toar type: string required: - type - parameters title: TransformToar type: object - additionalProperties: false description: Convert imagery to Cloud Optimized GeoTIFF or NITF formats properties: parameters: additionalProperties: false properties: format: type: string required: - format type: object type: enum: - file_format type: string required: - type - parameters title: TransformFileFormat type: object type: array updated: format: date-time type: string type: object - properties: _links: properties: _self: type: string type: object type: object SubscriptionSource: additionalProperties: false description: Source block to define the subscription source parameters properties: parameters: oneOf: - additionalProperties: false description: >- Catalog source parameters based on imagery available in the Data API properties: asset_types: items: type: string minItems: 1 type: array end_time: format: date-time type: string filter: type: object geometry: type: object geometry_relation: description: > Specify the relationship between the subscription geometry and the item geometry. Intersects (default): Returns items whose footprint geometry partially or fully overlaps with the subscription geometry. Contains: Returns items where the footprint geometry fully encloses the AOI. Within: Returns items whose entire footprint geometry is fully contained within the AOI. type: string item_types: items: type: string minItems: 1 type: array publishing_stages: description: > Specify image publishing stages to receive; preview, standard, or finalized. If not specified, a default value will be determined based on the item-type of the subscription. PSScene: standard, finalized. SkySatCollect, SkySatScene, and SkySatVideo: finalized. Note that this parameter cannot be used with item-types that lack a publishing_stage metadata value (e.g., Sentinel2L1C). example: - standard - finalized items: type: string minItems: 1 type: array rrule: description: Recurrence rule (iCalendar RFC 5545) example: FREQ=MONTHLY;BYMONTH=3,4,5,6,7 type: string start_time: format: date-time type: string time_range_type: description: > Specify the date field in the image metadata to utilize for matching images within the subscription start and end time. Choose between the "published" date (when the image was made published to the catalog) or the "acquired" date (when the image was captured or collected). example: published type: string required: - item_types - asset_types title: DataAPISource Parameters type: object - additionalProperties: false description: >- Sources for data resources beyond what is available in the Data API properties: end_time: format: date-time type: string geometry: type: object id: type: string start_time: format: date-time type: string required: - id - geometry - start_time title: SubscriptionSource Parameters type: object type: object type: oneOf: - enum: - catalog type: string - enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string required: - parameters title: Subscription Source type: object SubscriptionSourceParameters: additionalProperties: false description: Sources for data resources beyond what is available in the Data API properties: end_time: format: date-time type: string geometry: type: object id: type: string start_time: format: date-time type: string required: - id - geometry - start_time title: SubscriptionSource Parameters type: object SubscriptionStatuses: properties: cancelled: type: integer completed: type: integer failed: type: integer invalid: type: integer pending: type: integer preparing: type: integer running: type: integer suspended: type: integer type: object SubscriptionSummaryResponse: properties: results: properties: created: type: integer failed: type: integer processing: type: integer queued: type: integer success: type: integer type: object subscription: properties: status: type: string type: object type: object SubscriptionSuspensionRequest: properties: details: description: Details about the suspension reason type: string type: object SubscriptionUpdateRequestSimple: additionalProperties: false description: Subscription Request properties: delivery: description: A delivery mechanism. oneOf: - additionalProperties: false description: Credentials and bucket for delivery to Google Cloud properties: parameters: additionalProperties: false properties: bucket: description: GCS bucket name. type: string credentials: description: JSON-string of service account for bucket. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - credentials type: object type: enum: - google_cloud_storage type: string required: - type - parameters title: GCS type: object - additionalProperties: false description: Amazon S3 destination details properties: parameters: additionalProperties: false properties: aws_access_key_id: description: S3 account access key. type: string aws_region: description: AWS region bucket resides in. type: string aws_secret_access_key: description: S3 account secret key. type: string bucket: description: S3 bucket to send results type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string required: - bucket - aws_region - aws_access_key_id - aws_secret_access_key type: object type: enum: - amazon_s3 type: string required: - type - parameters title: AWS type: object - additionalProperties: false description: Azure blob storage details. properties: parameters: additionalProperties: false properties: account: description: Azure account. type: string container: description: Blob storage container name. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string sas_token: description: Shared-Access Signature token. type: string storage_endpoint_suffix: description: The storage endpoint suffix. type: string required: - account - container - sas_token type: object type: enum: - azure_blob_storage type: string required: - type - parameters title: Azure type: object - additionalProperties: false description: Oracle Cloud Storage destination details properties: parameters: additionalProperties: false properties: bucket: description: Oracle bucket to send results. type: string customer_access_key_id: description: Oracle account access key. type: string customer_secret_key: description: Oracle account secret key. type: string namespace: description: Oracle Object Storage namespace. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Oracle region bucket resides in. type: string required: - bucket - customer_access_key_id - customer_secret_key - region - namespace type: object type: enum: - oracle_cloud_storage type: string required: - type - parameters title: OCS type: object - additionalProperties: false description: GEE delivery details properties: parameters: additionalProperties: false properties: collection: description: GEE Image Collection name. type: string credentials: description: JSON-string of service account for image collection. type: string project: description: GEE project name type: string required: - collection - credentials - project type: object type: enum: - google_earth_engine type: string required: - type - parameters title: GEE type: object - additionalProperties: false description: S3 compatible destination details properties: parameters: additionalProperties: false properties: access_key_id: description: Access key for authentication. type: string bucket: description: S3-compatible bucket to send results. type: string endpoint: description: S3-compatible service endpoint. type: string path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string region: description: Region for the S3-compatible service. type: string secret_access_key: description: Secret key for authentication. type: string use_path_style: default: false description: Use path-style addressing with bucket name in URL. type: boolean required: - endpoint - bucket - region - access_key_id - secret_access_key type: object type: enum: - s3_compatible type: string required: - type - parameters title: S3 Compatible type: object - additionalProperties: false description: >- Delivery to a destination configured via Planet's Destinations API. properties: parameters: additionalProperties: false properties: path_prefix: description: >- A delivery path prefix. A path prefix is valid if it is 1 – 128 characters long, uses only Unicode letters, numbers, and -, ., _, /, does not start or end with -, _, or /, and does not allow trailing or consecutive -, _, or /. example: of-interest/ type: string ref: description: >- pl:ref URI from a destination configured via Planet's Destinations API. type: string required: - ref type: object type: enum: - destination type: string required: - type - parameters title: Planet Destination type: object type: object hosting: anyOf: - additionalProperties: false description: >- Planet Insights Platform (formerly Sentinel Hub) hosting details. properties: parameters: additionalProperties: false properties: collection_id: description: > A data collection to deliver to. If omitted, a new collection will be created for you and returned in the response. Collections can be found on the [Planet Insights Platform](https://insights.planet.com/data/collections). format: uuid type: string configuration_id: description: | Specifies the ID of the layer configuration. - If `create_configuration` is enabled, this field will contain the ID of the newly created layer configuration. - Any provided value will be ignored. format: uuid type: string create_configuration: description: > Determines whether to automatically create a layer configuration for your collection. - The configuration will be assigned the same name as the collection. - If no compatible configuration is found, the operation will return an error. - The `collection_id` parameter cannot be specified when `create_configuration` is set to `true`. type: boolean type: object type: enum: - sentinel_hub type: string required: - type title: Planet Insights Platform Hosting type: object description: > Specify a data hosting location. A hosting location removes the need to specify a delivery location. Specifying both is not allowed. This location cannot be updated after a subscription has been created. type: object name: description: Name of the subscription type: string source: additionalProperties: false description: Source block to define the update subscription source parameters properties: parameters: oneOf: - additionalProperties: false description: >- Catalog source parameters based on imagery available in the Data API properties: asset_types: items: type: string minItems: 1 type: array end_time: format: date-time type: string filter: type: object geom_ref: type: string geometry: type: object item_types: items: type: string minItems: 1 type: array publishing_stages: description: > Specify image publishing stages to receive; preview, standard, or finalized. If not specified, a default value will be determined based on the item-type of the subscription. PSScene: standard, finalized. SkySatCollect, SkySatScene, and SkySatVideo: finalized. Note that this parameter cannot be used with item-types that lack a publishing_stage metadata value (e.g., Sentinel2L1C). example: - standard - finalized items: type: string minItems: 1 type: array rrule: description: Recurrence rule (iCalendar RFC 5545) example: FREQ=MONTHLY;BYMONTH=3,4,5,6,7 type: string start_time: format: date-time type: string time_range_type: description: > Specify the date field in the image metadata to utilize for matching images within the subscription start and end time. Choose between the "published" date (when the image was made published to the catalog) or the "acquired" date (when the image was captured or collected). example: published type: string title: UpdateDataAPISource Parameters type: object - additionalProperties: false description: >- Sources for data resources beyond what is available in the Data API properties: end_time: format: date-time type: string geom_ref: type: string geometry: type: object id: type: string start_time: format: date-time type: string title: UpdateSubscriptionSource Parameters type: object type: object type: oneOf: - enum: - catalog type: string - enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string required: - parameters title: Update Subscription Source type: object tools: description: A list of blocks for processing items obtained from 'source'. items: anyOf: - additionalProperties: false description: Provide a clipping AOI for items. properties: parameters: additionalProperties: false properties: aoi: description: >- Providing a clip AOI is optional. When this parameter is omitted, the subscription geometry will be used (so long as the clip tool is still specified). type: object type: object type: enum: - clip type: string required: - type - parameters title: TransformClip type: object - additionalProperties: false description: Provide desired projection for imagery assets properties: parameters: additionalProperties: false properties: kernel: type: string projection: type: string resolution: format: float type: number required: - projection type: object type: enum: - reproject type: string required: - type - parameters title: TransformReproject type: object - additionalProperties: false description: Apply band math expressions to images properties: parameters: additionalProperties: false properties: b1: type: string b10: type: string b11: type: string b12: type: string b13: type: string b14: type: string b15: type: string b2: type: string b3: type: string b4: type: string b5: type: string b6: type: string b7: type: string b8: type: string b9: type: string pixel_type: type: string type: object type: enum: - bandmath type: string required: - type - parameters title: TransformBandmath type: object - additionalProperties: false description: >- Radiometrically harmonize imagery to a different sensor. Currently Sentinel-2 the only supported target sensor. properties: parameters: additionalProperties: false properties: target_sensor: type: string required: - target_sensor type: object type: enum: - harmonize type: string required: - type - parameters title: TransformHarmonize type: object - additionalProperties: false description: >- Convert analytic imagery products to top of atmosphere reflectance products properties: parameters: additionalProperties: false properties: scale_factor: default: 10000 type: integer type: object type: enum: - toar type: string required: - type - parameters title: TransformToar type: object - additionalProperties: false description: Convert imagery to Cloud Optimized GeoTIFF or NITF formats properties: parameters: additionalProperties: false properties: format: type: string required: - format type: object type: enum: - file_format type: string required: - type - parameters title: TransformFileFormat type: object - description: >- Filter imagery based on updated metadata values ("cloud_cover", "shadow_percent", "clear_percent", "snow_ice_percent", "heavy_haze_percent", "light_haze_percent") after a scene has been clipped to a provided AOI. This tool requires that the clip tool is also used. properties: parameters: additionalProperties: false anyOf: - required: - cloud_percent - required: - clear_percent - required: - shadow_percent - required: - snow_ice_percent - required: - heavy_haze_percent - required: - light_haze_percent properties: clear_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object cloud_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object heavy_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object light_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object shadow_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object snow_ice_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object type: object type: enum: - cloud_filter type: string required: - type - parameters title: TransformCloudFilter type: object type: array required: - name - source type: object SummaryResponse: properties: subscriptions: properties: cancelled: type: integer completed: type: integer failed: type: integer invalid: type: integer pending: type: integer preparing: type: integer running: type: integer suspended: type: integer type: object type: object SummarySubscription: properties: status: type: string type: object TransformBandmath: additionalProperties: false description: Apply band math expressions to images properties: parameters: additionalProperties: false properties: b1: type: string b10: type: string b11: type: string b12: type: string b13: type: string b14: type: string b15: type: string b2: type: string b3: type: string b4: type: string b5: type: string b6: type: string b7: type: string b8: type: string b9: type: string pixel_type: type: string type: object type: enum: - bandmath type: string required: - type - parameters title: TransformBandmath type: object TransformClipSimple: additionalProperties: false description: Provide a clipping AOI for items. properties: parameters: additionalProperties: false properties: aoi: description: >- Providing a clip AOI is optional. When this parameter is omitted, the subscription geometry will be used (so long as the clip tool is still specified). type: object type: object type: enum: - clip type: string required: - type - parameters title: TransformClip type: object TransformCloudFilter: description: >- Filter imagery based on updated metadata values ("cloud_cover", "shadow_percent", "clear_percent", "snow_ice_percent", "heavy_haze_percent", "light_haze_percent") after a scene has been clipped to a provided AOI. This tool requires that the clip tool is also used. properties: parameters: additionalProperties: false anyOf: - required: - cloud_percent - required: - clear_percent - required: - shadow_percent - required: - snow_ice_percent - required: - heavy_haze_percent - required: - light_haze_percent properties: clear_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object cloud_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object heavy_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object light_haze_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object shadow_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object snow_ice_percent: additionalProperties: false anyOf: - required: - gte - required: - lte properties: gte: description: Greater than or equal to value. format: double maximum: 100 minimum: 0 type: number lte: description: Less than or equal to value. format: double maximum: 100 minimum: 0 type: number type: object type: object type: enum: - cloud_filter type: string required: - type - parameters title: TransformCloudFilter type: object TransformFileFormat: additionalProperties: false description: Convert imagery to Cloud Optimized GeoTIFF or NITF formats properties: parameters: additionalProperties: false properties: format: type: string required: - format type: object type: enum: - file_format type: string required: - type - parameters title: TransformFileFormat type: object TransformHarmonize: additionalProperties: false description: >- Radiometrically harmonize imagery to a different sensor. Currently Sentinel-2 the only supported target sensor. properties: parameters: additionalProperties: false properties: target_sensor: type: string required: - target_sensor type: object type: enum: - harmonize type: string required: - type - parameters title: TransformHarmonize type: object TransformReproject: additionalProperties: false description: Provide desired projection for imagery assets properties: parameters: additionalProperties: false properties: kernel: type: string projection: type: string resolution: format: float type: number required: - projection type: object type: enum: - reproject type: string required: - type - parameters title: TransformReproject type: object TransformToar: additionalProperties: false description: >- Convert analytic imagery products to top of atmosphere reflectance products properties: parameters: additionalProperties: false properties: scale_factor: default: 10000 type: integer type: object type: enum: - toar type: string required: - type - parameters title: TransformToar type: object UnauthenticatedResponse: example: API key not found type: string UnexpectedErrorResponse: example: error: details: [] reason: Unexpected error properties: error: properties: details: items: {} type: array reason: example: Unexpected error type: string type: object type: object UpdateDataAPISourceParameters: additionalProperties: false description: Catalog source parameters based on imagery available in the Data API properties: asset_types: items: type: string minItems: 1 type: array end_time: format: date-time type: string filter: type: object geom_ref: type: string geometry: type: object item_types: items: type: string minItems: 1 type: array publishing_stages: description: > Specify image publishing stages to receive; preview, standard, or finalized. If not specified, a default value will be determined based on the item-type of the subscription. PSScene: standard, finalized. SkySatCollect, SkySatScene, and SkySatVideo: finalized. Note that this parameter cannot be used with item-types that lack a publishing_stage metadata value (e.g., Sentinel2L1C). example: - standard - finalized items: type: string minItems: 1 type: array rrule: description: Recurrence rule (iCalendar RFC 5545) example: FREQ=MONTHLY;BYMONTH=3,4,5,6,7 type: string start_time: format: date-time type: string time_range_type: description: > Specify the date field in the image metadata to utilize for matching images within the subscription start and end time. Choose between the "published" date (when the image was made published to the catalog) or the "acquired" date (when the image was captured or collected). example: published type: string title: UpdateDataAPISource Parameters type: object UpdateSubscriptionSource: additionalProperties: false description: Source block to define the update subscription source parameters properties: parameters: oneOf: - additionalProperties: false description: >- Catalog source parameters based on imagery available in the Data API properties: asset_types: items: type: string minItems: 1 type: array end_time: format: date-time type: string filter: type: object geom_ref: type: string geometry: type: object item_types: items: type: string minItems: 1 type: array publishing_stages: description: > Specify image publishing stages to receive; preview, standard, or finalized. If not specified, a default value will be determined based on the item-type of the subscription. PSScene: standard, finalized. SkySatCollect, SkySatScene, and SkySatVideo: finalized. Note that this parameter cannot be used with item-types that lack a publishing_stage metadata value (e.g., Sentinel2L1C). example: - standard - finalized items: type: string minItems: 1 type: array rrule: description: Recurrence rule (iCalendar RFC 5545) example: FREQ=MONTHLY;BYMONTH=3,4,5,6,7 type: string start_time: format: date-time type: string time_range_type: description: > Specify the date field in the image metadata to utilize for matching images within the subscription start and end time. Choose between the "published" date (when the image was made published to the catalog) or the "acquired" date (when the image was captured or collected). example: published type: string title: UpdateDataAPISource Parameters type: object - additionalProperties: false description: >- Sources for data resources beyond what is available in the Data API properties: end_time: format: date-time type: string geom_ref: type: string geometry: type: object id: type: string start_time: format: date-time type: string title: UpdateSubscriptionSource Parameters type: object type: object type: oneOf: - enum: - catalog type: string - enum: - soil_water_content - biomass_proxy - vegetation_optical_depth - land_surface_temperature type: string required: - parameters title: Update Subscription Source type: object UpdateSubscriptionSourceParameters: additionalProperties: false description: Sources for data resources beyond what is available in the Data API properties: end_time: format: date-time type: string geom_ref: type: string geometry: type: object id: type: string start_time: format: date-time type: string title: UpdateSubscriptionSource Parameters type: object Webhook: additionalProperties: false description: Set params for webhook notifications properties: topics: items: enum: - delivery.success - delivery.match - delivery.failed - status.backfill.completed - status.completed - status.cancelled - status.pending - status.all - status.suspended - status.failed type: string minItems: 1 type: array uniqueItems: true url: format: uri type: string required: - url - topics title: Webhook notification type: object securitySchemes: ApiKeyAuth: in: header name: Authorization type: apiKey BasicAuth: scheme: basic type: http info: title: Planet Subscriptions service API version: 1.0.0 openapi: 3.0.0 paths: /subscriptions/v1: get: operationId: listSubscriptions parameters: - $ref: '#/components/parameters/CreatedParameter' - $ref: '#/components/parameters/EndTimeParameter' - $ref: '#/components/parameters/HostingParameter' - $ref: '#/components/parameters/NameContainsParameter' - $ref: '#/components/parameters/NameParameter' - $ref: '#/components/parameters/PageMarkerParameter' - $ref: '#/components/parameters/PageSizeParameter' - $ref: '#/components/parameters/SourceTypeParameter' - $ref: '#/components/parameters/StartTimeParameter' - $ref: '#/components/parameters/StatusParameter' - $ref: '#/components/parameters/SortByParameter' - $ref: '#/components/parameters/UpdatedParameter' - $ref: '#/components/parameters/UserIDExtendedParameter' - $ref: '#/components/parameters/GeomRefParameter' responses: '200': content: application/json: schema: properties: _links: properties: _self: description: RFC 3986 URI representing the location of this object. type: string next: description: >- RFC 3986 URI representing the location of the next page of results. Omitted when there are no results, or the current page is the last. type: string type: object subscriptions: items: $ref: '#/components/schemas/SubscriptionResponse' type: array description: A paged array of subscriptions '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: List all subscriptions tags: - subscriptions post: operationId: createSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionCreateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionResponse' description: Subscription created successfully '400': content: application/json: examples: failedSchemaValidation: value: error: details: [] reason: Request failed schema validation problemWithRequest: value: error: details: [] reason: Problem with request sourceIssue: value: error: details: [] reason: Source issue schema: properties: error: properties: details: items: {} type: array reason: enum: - Request failed schema validation - Problem with request - Source issue type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Unexpected error summary: Create a subscription tags: - subscriptions /subscriptions/v1/bulk: post: operationId: bulkCreateSubscriptions requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionBulkCreateRequest' required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/SubscriptionBulkCreateResponse' description: Bulk create request submitted successfully '400': content: application/json: examples: failedSchemaValidation: value: error: details: [] reason: Request failed schema validation problemWithRequest: value: error: details: [] reason: Problem with request sourceIssue: value: error: details: [] reason: Source issue schema: properties: error: properties: details: items: {} type: array reason: enum: - Request failed schema validation - Problem with request - Source issue type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '409': content: application/json: schema: $ref: '#/components/schemas/ConflictResponse' description: Conflict headers: Retry-After: description: The number of seconds to wait before retrying the request. schema: format: int32 type: integer '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Create multiple subscriptions tags: - subscriptions - bulk /subscriptions/v1/reactivate: post: operationId: bulkReactivateSubscriptions parameters: - $ref: '#/components/parameters/UserIDExtendedParameter' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionBulkReactivateRequest' responses: '202': description: Bulk subscriptions reactivation request received '400': content: application/json: schema: properties: error: properties: details: items: {} type: array reason: enum: - Reactivate request failed - Problem with request type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '409': content: application/json: schema: $ref: '#/components/schemas/ConflictResponse' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error '503': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Service unavailable summary: >- Reactivate subscriptions for a given user ID, "all" subscriptions within the requesters organization, or specified subscription ids tags: - subscriptions - suspension/reactivation - bulk /subscriptions/v1/summary: get: operationId: getSummary responses: '200': content: application/json: schema: $ref: '#/components/schemas/SummaryResponse' description: A summary response '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Get a summary of all subscriptions tags: - subscriptions /subscriptions/v1/suspend: post: operationId: bulkSuspendSubscriptions parameters: - $ref: '#/components/parameters/UserIDExtendedParameter' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionBulkSuspendRequest' responses: '202': description: Bulk subscriptions suspension request received '400': content: application/json: schema: properties: error: properties: details: items: {} type: array reason: enum: - Suspend request failed - Problem with request type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '409': content: application/json: schema: $ref: '#/components/schemas/ConflictResponse' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error '503': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Service unavailable summary: >- Suspend subscriptions for a given user ID, "all" subscriptions within the requesters organization, or specified subscription ids tags: - subscriptions - suspension/reactivation - bulk /subscriptions/v1/{subscriptionId}: get: operationId: getSubscription responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionResponse' description: A subscription response '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Get a subscription tags: - subscriptions parameters: - in: path name: subscriptionId required: true schema: format: uuid type: string patch: operationId: patchSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionPatchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionResponse' description: A subscription response '400': content: application/json: examples: failedSchemaValidation: value: error: details: [] reason: Request failed schema validation problemWithRequest: value: error: details: [] reason: Problem with request schema: properties: error: properties: details: items: {} type: array reason: enum: - Request failed schema validation - Problem with request type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Patch a subscription tags: - subscriptions put: operationId: updateSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionUpdateRequestSimple' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionResponse' description: A subscription response '400': content: application/json: examples: failedSchemaValidation: value: error: details: [] reason: Request failed schema validation problemWithRequest: value: error: details: [] reason: Problem with request sourceIssue: value: error: details: [] reason: Source issue schema: properties: error: properties: details: items: {} type: array reason: enum: - Request failed schema validation - Problem with request - Source issue type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Update a subscription tags: - subscriptions /subscriptions/v1/{subscriptionId}/cancel: parameters: - in: path name: subscriptionId required: true schema: format: uuid type: string post: description: >- Permanently cancel a subscription and stop delivery. Supported when a subscription is `pending`, `running`, `failed`, or `suspended`. operationId: cancelSubscription responses: '200': description: Null response '400': content: application/json: examples: failedSchemaValidation: value: error: details: [] reason: Could not find requested subscription problemWithRequest: value: error: details: [] reason: Problem with request schema: properties: error: properties: details: items: {} type: array reason: enum: - Could not find requested subscription - Problem with request type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Cancel subscriptions tags: - subscriptions /subscriptions/v1/{subscriptionId}/reactivate: post: operationId: reactivateSubscription parameters: - in: path name: subscriptionId required: true schema: format: uuid type: string responses: '202': description: Subscription submitted for reactivation '400': content: application/json: examples: failedSchemaValidation: value: error: details: [] reason: Could not find requested subscription problemWithRequest: value: error: details: [] reason: Problem with request schema: properties: error: properties: details: items: {} type: array reason: enum: - Could not find requested subscription - Problem with request type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '409': content: application/json: schema: $ref: '#/components/schemas/ConflictResponse' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Reactivate a subscription tags: - subscriptions - suspension/reactivation /subscriptions/v1/{subscriptionId}/results: get: operationId: getResults parameters: - $ref: '#/components/parameters/PageMarkerDateParameter' - $ref: '#/components/parameters/PageSizeParameter' - $ref: '#/components/parameters/ResultsStatusParameter' - $ref: '#/components/parameters/CreatedParameter' - $ref: '#/components/parameters/UpdatedParameter' - $ref: '#/components/parameters/CompletedParameter' - $ref: '#/components/parameters/ItemDatetimeParameter' - $ref: '#/components/parameters/FormatParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultsResponse' description: A page of results '400': content: application/json: examples: failedSchemaValidation: value: error: details: [] reason: Could not find requested subscription problemWithRequest: value: error: details: [] reason: Problem with request schema: properties: error: properties: details: items: {} type: array reason: enum: - Could not find requested subscription - Problem with request type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Get results for a given subscription tags: - results parameters: - in: path name: subscriptionId required: true schema: format: uuid type: string /subscriptions/v1/{subscriptionId}/summary: get: operationId: getSubscriptionSummary responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionSummaryResponse' description: A subscription summary response '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Get a summary of results for a given subscription tags: - results parameters: - in: path name: subscriptionId required: true schema: format: uuid type: string /subscriptions/v1/{subscriptionId}/suspend: post: operationId: suspendSubscription parameters: - in: path name: subscriptionId required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionSuspensionRequest' responses: '202': content: application/json: schema: $ref: '#/components/schemas/SubscriptionResponse' description: Subscription submitted for suspension '400': content: application/json: examples: failedSchemaValidation: value: error: details: [] reason: Could not find requested subscription problemWithRequest: value: error: details: [] reason: Problem with request schema: properties: error: properties: details: items: {} type: array reason: enum: - Could not find requested subscription - Problem with request type: string type: object type: object description: Bad Request '401': content: text/plain: schema: $ref: '#/components/schemas/UnauthenticatedResponse' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedResponse' description: Permission denied '409': content: application/json: schema: $ref: '#/components/schemas/ConflictResponse' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Internal server error summary: Suspend a subscription tags: - subscriptions - suspension/reactivation security: - ApiKeyAuth: [] - BasicAuth: [] servers: - url: https://api.planet.com