{ "opencollection": "1.0.0", "info": { "name": "API Reference async_process byoc_tile API", "version": "1.0.0" }, "items": [ { "info": { "name": "byoc_tile", "type": "folder" }, "items": [ { "info": { "name": "Get collection tiles", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/tiles", "params": [ { "name": "collectionId", "value": "", "type": "path" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve." }, { "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" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the tiles by created date in ascending or descending order." }, { "name": "path", "value": "", "type": "query", "description": "Get the tile with the exact path. Returns a single tile or no tile, if there's none with given path." }, { "name": "status", "value": "", "type": "query", "description": "Get only the files with the given status." } ], "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 collection tiles" }, { "info": { "name": "Create a tile", "type": "http" }, "http": { "method": "POST", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/tiles", "params": [ { "name": "collectionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "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": "Create a tile" }, { "info": { "name": "Get a tile", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/tiles/:tileId", "params": [ { "name": "collectionId", "value": "", "type": "path" }, { "name": "tileId", "value": "", "type": "path" } ], "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 tile" }, { "info": { "name": "Update a tile", "type": "http" }, "http": { "method": "PUT", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/tiles/:tileId", "params": [ { "name": "collectionId", "value": "", "type": "path" }, { "name": "tileId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "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": "Update a tile" }, { "info": { "name": "Delete a tile", "type": "http" }, "http": { "method": "DELETE", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/tiles/:tileId", "params": [ { "name": "collectionId", "value": "", "type": "path" }, { "name": "tileId", "value": "", "type": "path" } ], "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": "Delete a tile" }, { "info": { "name": "Reingest a tile", "type": "http" }, "http": { "method": "POST", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/tiles/:tileId/reingest", "params": [ { "name": "collectionId", "value": "", "type": "path" }, { "name": "tileId", "value": "", "type": "path" } ], "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": "Initiates reingestion of a tile." }, { "info": { "name": "List files of a tile in your Planet collection", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/tiles/:tileId/files", "params": [ { "name": "collectionId", "value": "", "type": "path" }, { "name": "tileId", "value": "", "type": "path" } ], "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": "List files of a tile in your Planet collection" }, { "info": { "name": "Retrieve a file from your Planet collection tile", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/tiles/:tileId/files/:path", "headers": [ { "name": "Range", "value": "bytes=16384-23473" } ], "params": [ { "name": "collectionId", "value": "", "type": "path" }, { "name": "tileId", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path", "description": "Filename with path as returned by the \"List files of a tile\" 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": "Retrieve a file from your Planet collection tile" }, { "info": { "name": "Get size of a file from your Planet collection tile", "type": "http" }, "http": { "method": "HEAD", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/tiles/:tileId/files/:path", "params": [ { "name": "collectionId", "value": "", "type": "path" }, { "name": "tileId", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path", "description": "Filename with path as returned by the \"List files of a tile\" 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 size of a file from your Planet collection tile" } ] } ], "bundled": true }