{ "opencollection": "1.0.0", "info": { "name": "API Reference async_process byoc_collection API", "version": "1.0.0" }, "items": [ { "info": { "name": "byoc_collection", "type": "folder" }, "items": [ { "info": { "name": "Query collections", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/byoc/v1/collections", "params": [ { "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": "search", "value": "", "type": "query", "description": "Optional search query. Either a single word to search for or multiple words separated by the `|` (or) and `&` (and) operators. If omitted, all items are returned." } ], "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": "Query collections" }, { "info": { "name": "Create a collection", "type": "http" }, "http": { "method": "POST", "url": "https://services.sentinel-hub.com/byoc/v1/collections", "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 collection" }, { "info": { "name": "Get a collection", "type": "http" }, "http": { "method": "GET", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId", "params": [ { "name": "collectionId", "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 collection" }, { "info": { "name": "Update a collection", "type": "http" }, "http": { "method": "PUT", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId", "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": "Update a collection" }, { "info": { "name": "Delete a collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId", "params": [ { "name": "collectionId", "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 collection" }, { "info": { "name": "Copy collection tiles", "type": "http" }, "http": { "method": "POST", "url": "https://services.sentinel-hub.com/byoc/v1/collections/:collectionId/copyTiles", "params": [ { "name": "collectionId", "value": "", "type": "path" }, { "name": "toCollection", "value": "", "type": "query" } ], "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": "Copies ingested tiles from one collection to another, but only those whose path isn't present in the target collection.\n\nYou need to have access to both source and target collections, and target collection needs to have either the same band names and types, or it should have no bands.\n" } ] } ], "bundled": true }