{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference async_process dataimport_subscription API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "dataimport_subscription",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Query subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions",
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter subscriptions by status. Omit to get all subscriptions."
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "query",
                "description": "Filter subscriptions by collectionId. Omit to get all subscriptions."
              },
              {
                "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"
              },
              {
                "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."
              },
              {
                "name": "deleted",
                "value": "",
                "type": "query",
                "description": "If set to `true` the response will only return those subscriptions that had been deleted by the user."
              }
            ],
            "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 subscriptions"
        },
        {
          "info": {
            "name": "Create a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions",
            "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 non-confirmed data subscription object. After creation you can review the parameters of the subscription and then choose to confirm it or not.\n"
        },
        {
          "info": {
            "name": "Get a subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Subscription 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"
        },
        {
          "info": {
            "name": "Delete a non-running subscription",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Subscription 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": "`CREATED` subscriptions will be permanently deleted.\n\n `CANCELLED` , `COMPLETED` or `FAILED` ones will be deleted for normal querying but will still be available.\n\n `RUNNING` subscriptions cannot be deleted."
        },
        {
          "info": {
            "name": "Confirm a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/confirm",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Subscription 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": "Confirm the subscription and start executing it. Only subscription with status CREATED can be confirmed.\n"
        },
        {
          "info": {
            "name": "Cancel a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/subscriptions/:subscriptionId/cancel",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Subscription 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": "Cancel a RUNNING subscription so that it will stop executing. Already imported data will be kept. Only subscription with status RUNNING can be cancelled.\n"
        }
      ]
    }
  ],
  "bundled": true
}