{ "opencollection": "1.0.0", "info": { "name": "API Reference async_process dataimport_subscription_delivery API", "version": "1.0.0" }, "items": [ { "info": { "name": "dataimport_subscription_delivery", "type": "folder" }, "items": [ { "info": { "name": "Get subscription deliveries", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/deliveries", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "status", "value": "", "type": "query", "description": "Filter deliveries by status. Omit to get all deliveries." }, { "name": "count", "value": "", "type": "query", "description": "Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used.\nFor more records, use *viewtoken* to page through." }, { "name": "viewtoken", "value": "", "type": "query", "description": "When the total number of items is larger than *count*, the response contains *viewtoken*.\nThis *viewtoken* can be used in the next request to retrieve the next page of items.\n\nThe next page can be retrieved by repeating the query. However, replace your URL with the\nnext URL in the returned links object.\n" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get subscription deliveries" }, { "info": { "name": "Get a subscription delivery", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/deliveries/:deliveryId", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "deliveryId", "value": "", "type": "path", "description": "Delivery ID" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a subscription delivery" }, { "info": { "name": "List files of a subscription delivery", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/deliveries/:deliveryId/files", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "deliveryId", "value": "", "type": "path", "description": "Delivery ID" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all files delivered by the data provider. The file list and contents is provider-specific.\n" }, { "info": { "name": "Retrieve a delivery file", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/deliveries/:deliveryId/files/:file", "headers": [ { "name": "Range", "value": "bytes=16384-23473" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "deliveryId", "value": "", "type": "path", "description": "Delivery ID" }, { "name": "file", "value": "", "type": "path", "description": "File with full path as returned by the \"List delivery files\" endpoint." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Download a single file delivered by the data provider." }, { "info": { "name": "Get delivery file size", "type": "http" }, "http": { "method": "HEAD", "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/deliveries/:deliveryId/files/:file", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "deliveryId", "value": "", "type": "path", "description": "Delivery ID" }, { "name": "file", "value": "", "type": "path", "description": "File with full path as returned by the \"List delivery files\" endpoint." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get delivery file size" }, { "info": { "name": "Request creation of delivery archive", "type": "http" }, "http": { "method": "POST", "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/deliveries/:deliveryId/archive/create", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "deliveryId", "value": "", "type": "path", "description": "Delivery ID" }, { "name": "format", "value": "", "type": "query", "description": "One of supported archive formats. Currently only `zip` is supported." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Request creation of delivery archive" }, { "info": { "name": "Retrieve delivery archive", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/deliveries/:deliveryId/archive", "headers": [ { "name": "Range", "value": "bytes=16384-23473" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "deliveryId", "value": "", "type": "path", "description": "Delivery ID" }, { "name": "format", "value": "", "type": "query", "description": "One of supported archive formats. Currently only `zip` is supported." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve delivery archive" }, { "info": { "name": "Get size of delivery archive", "type": "http" }, "http": { "method": "HEAD", "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/deliveries/:deliveryId/archive", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "deliveryId", "value": "", "type": "path", "description": "Delivery ID" }, { "name": "format", "value": "", "type": "query", "description": "One of supported archive formats. Currently only `zip` is supported." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get size of delivery archive" }, { "info": { "name": "Get status of delivery archive creation", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/deliveries/:deliveryId/archive/status", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "deliveryId", "value": "", "type": "path", "description": "Delivery ID" }, { "name": "format", "value": "", "type": "query", "description": "One of supported archive formats. Currently only `zip` is supported." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get status of delivery archive creation" } ] } ], "bundled": true }