{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Streams API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Streams",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List streams",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams"
          },
          "docs": "\n\n> **Required capabilities:** `streamsAcl:READ`\n\nList all streams available in the project.\n"
        },
        {
          "info": {
            "name": "Create stream",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `streamsAcl:CREATE`\n\nCreate a new stream. A stream is a target for high volume data ingestion,\nwith data shaped by the Data Modeling concepts. Specify an external ID and a stream template for each stream. The template defines the stream's mutability, limits, and lifecycle.\n"
        },
        {
          "info": {
            "name": "Retrieve stream",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/:streamId",
            "params": [
              {
                "name": "streamId",
                "value": "",
                "type": "path",
                "description": "An identifier of the stream where the records are stored.\n"
              },
              {
                "name": "includeStatistics",
                "value": "",
                "type": "query",
                "description": "If set to ```true```, usage statistics will be  returned together with stream settings.\n"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `streamsAcl:READ`\n\nRetrieve a stream by its identifier.\n"
        },
        {
          "info": {
            "name": "Delete stream (DEPRECATED)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/:streamId",
            "params": [
              {
                "name": "streamId",
                "value": "",
                "type": "path",
                "description": "An identifier of the stream where the records are stored.\n"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `streamsAcl:DELETE`\n\n**DEPRECATED**: This endpoint is no longer supported and returns HTTP 410 Gone.\nPlease use `POST /streams/delete` instead.\n"
        },
        {
          "info": {
            "name": "Delete stream",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `streamsAcl:DELETE`\n\nDelete a stream by its identifier, along with all records stored in the stream.\n\nIf the stream does not exist, the operation succeeds without error (idempotent delete).\n"
        }
      ]
    }
  ],
  "bundled": true
}