{
  "opencollection": "1.0.0",
  "info": {
    "name": "SingleStore Data Files Workspaces API",
    "version": "v2"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Workspaces",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Workspaces",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{workspaceHost}/workspaces",
            "params": [
              {
                "name": "workspaceGroupID",
                "value": "",
                "type": "query",
                "description": "Filter workspaces by the unique ID of the workspace group they belong to."
              }
            ]
          },
          "docs": "Retrieves all workspaces accessible to the authenticated user, optionally filtered by workspace group ID. Returns workspace details including state, size, endpoint, and configuration."
        },
        {
          "info": {
            "name": "Create a Workspace",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{workspaceHost}/workspaces",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new workspace within an existing workspace group. The workspace provides compute capacity connected to the SingleStore database engine. Workspace size determines the number of vCPUs and memory allocated."
        },
        {
          "info": {
            "name": "Get a Workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{workspaceHost}/workspaces/:workspaceID",
            "params": [
              {
                "name": "workspaceID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the workspace."
              }
            ]
          },
          "docs": "Retrieves detailed information about a specific workspace identified by its unique ID, including its current state, endpoint hostname, size, auto-suspend settings, and cache configuration."
        },
        {
          "info": {
            "name": "Update a Workspace",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{workspaceHost}/workspaces/:workspaceID",
            "params": [
              {
                "name": "workspaceID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the workspace."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the configuration of an existing workspace, such as its auto-suspend settings, cache multiplier, size, or deployment type. Only the fields provided in the request body are modified."
        },
        {
          "info": {
            "name": "Terminate a Workspace",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{workspaceHost}/workspaces/:workspaceID",
            "params": [
              {
                "name": "workspaceID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the workspace."
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "When set to true, forces termination of the workspace even if it is in an intermediate state."
              }
            ]
          },
          "docs": "Terminates and permanently deletes the specified workspace. This operation is irreversible. The workspace must be in a non-transitional state before it can be terminated."
        },
        {
          "info": {
            "name": "Suspend a Workspace",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{workspaceHost}/workspaces/:workspaceID/suspend",
            "params": [
              {
                "name": "workspaceID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the workspace."
              }
            ]
          },
          "docs": "Suspends an active workspace, pausing compute billing while retaining the workspace configuration and associated data. The workspace can be resumed at any time using the resume endpoint."
        },
        {
          "info": {
            "name": "Resume a Workspace",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{workspaceHost}/workspaces/:workspaceID/resume",
            "params": [
              {
                "name": "workspaceID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the workspace."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Resumes a suspended workspace, restoring compute capacity and making the workspace available for database connections. Optionally disables auto-suspend when resuming."
        }
      ]
    }
  ],
  "bundled": true
}