# Management API Reference

* **components**
  * **parameters**
    * **cloudPrincipalID**
      * *description: ID of the cloud principal*

      * *in: path*

      * *name: cloudPrincipalID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **cloudfunctionID**
      * *description: ID of the cloud function*

      * *example: 7b68b78d-a000-4000-9000-0864fd331524*

      * *in: path*

      * *name: cloudfunctionID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **connectionID**
      * *description: ID of the private connection*

      * *in: path*

      * *name: connectionID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **fields**
      * *description: Comma-separated values list that correspond to the filtered fields for returned entities*

      * *in: query*

      * *name: fields*

      * **schema**
        * *type: string*

    * **flowID**
      * *description: ID of the SingleStore Flow instance*

      * *in: path*

      * *name: flowID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **invitationID**
      * *description: ID of the user invitation*

      * *in: path*

      * *name: invitationID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **jobID**
      * *description: ID of the job*

      * *example: 7b68b78d-a000-4000-9000-0864fd331524*

      * *in: path*

      * *name: jobID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **lastKnownUpdatedAt**
      * *description: The timestamp used for concurrency control. The resource will be updated only if the current last updated timestamp matches the given value.*

      * *example: 2026-01-18T09:56:56Z*

      * *in: query*

      * *name: lastKnownUpdatedAt*

      * **schema**
        * *format: date-time*

        * *type: string*

    * **limit**
      * *description: Maximum number of items to return in a paginated query*

      * *in: query*

      * *name: limit*

      * **schema**
        * *type: integer*

    * **offsetID**
      * *description: ID of the last item from the previous page, used to continue pagination.*

      * *in: query*

      * *name: offsetID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **organizationID**
      * *description: ID of the organization*

      * *in: path*

      * *name: organizationID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **projectID**
      * *description: ID of the project*

      * *in: path*

      * *name: projectID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **resourceType**
      * *description: Resource type*

      * **examples**
        * **cluster**
          * *value: cluster*

        * **organization**
          * *value: organization*

        * **secret**
          * *value: secret*

        * **team**
          * *value: team*

        * **workspace**
          * *value: workspace*

      * *in: path*

      * *name: resourceType*

      * **schema**
        * *type: string*

    * **role**
      * *description: The role name*

      * *in: path*

      * *name: role*

      * **schema**
        * *type: string*

    * **secretID**
      * *description: ID of the secret*

      * *in: path*

      * *name: secretID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **serviceAccountID**
      * *description: ID of the service account*

      * *in: path*

      * *name: serviceAccountID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **teamID**
      * *description: ID of the team*

      * *in: path*

      * *name: teamID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **updateNotebookSnapshot**
      * *description: Indicates whether to update the notebook snapshot after updating the cloud function.*

      * *in: query*

      * *name: updateNotebookSnapshot*

      * **schema**
        * *type: boolean*

    * **userID**
      * *description: ID of the user*

      * *in: path*

      * *name: userID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **workspaceGroupID**
      * *description: ID of the workspace group*

      * *in: path*

      * *name: workspaceGroupID*

      * **schema**
        * *format: uuid*

        * *type: string*

    * **workspaceID**
      * *description: ID of the workspace*

      * *in: path*

      * *name: workspaceID*

      * **schema**
        * *format: uuid*

        * *type: string*

  * **schemas**
    * **AppToken**
      * **properties**
        * **expiresAt**
          * *description: The time at which this JWT token will become invalid*

          * *example: 11-22-2024T15:04:05*

          * *type: string*

        * **jwt**
          * *description: The JWT token that can be used to interact with a singlestore native App*

          * *example: eyJhbGciOiJI...*

          * *type: string*

      * **required**
        * *0: jwt*

        * *1: expiresAt*

      * *type: object*

    * **AuditLog**
      * *description: Represents an audit log entry*

      * **properties**
        * **apiKeyID**
          * *description: The API key ID used to perform this action, if applicable*

          * *format: uuid*

          * *type: string*

        * **attributes**
          * *description: additional keys and values that are specific to the audit log type*

          * *type: object*

        * **auditID**
          * *example: 17290909-0000-1000-9000-e30410f1b05a*

          * *format: uuid*

          * *type: string*

        * **clusterID**
          * *description: The database cluster tied to this event*

          * *format: uuid*

          * *type: string*

        * **createdAt**
          * *description: The timestamp of when the audit log entry was created in RFC3339Nano format*

          * *type: string*

        * **error**
          * *description: text error message, if any relating to this entry*

          * *example: *

          * *type: string*

        * **firstName**
          * *description: The first name of a redacted user*

          * *type: string*

        * **labels**
          * *description: A list of audit keywords*

          * **example**
            * *0: featureflag*

          * **items**
            * *type: string*

          * *type: array*

        * **lastName**
          * *description: The last name of a redacted user*

          * *type: string*

        * **orgID**
          * *description: The organization tied to this event*

          * *format: uuid*

          * *type: string*

        * **projectID**
          * *description: This property is deprecated. This is an internal project ID, not related to other project related fields.*

          * *format: uuid*

          * *type: string*

        * **reason**
          * *description: A human-readable description of what happened*

          * *example: feature flag (ssoLogin) enabled for all orgs*

          * *type: string*

        * **sessionID**
          * *description: the authorization session id tied to this event*

          * *format: uuid*

          * *type: string*

        * **source**
          * *description: The audit log entry source*

          * **enum**
            * *0: Portal*

            * *1: Admin*

            * *2: SystemJob*

          * *example: Portal*

          * *type: string*

        * **teamID**
          * *description: ID of the team related to this event*

          * *format: uuid*

          * *type: string*

        * **type**
          * *description: The audit log entry type*

          * *example: Login*

          * *type: string*

        * **userEmail**
          * *description: The user email address*

          * *example: user\@email.com*

          * *type: string*

        * **userID**
          * *description: The user ID*

          * *example: 17290909-0000-1000-9000-e30410f1b05a*

          * *type: string*

        * **userType**
          * *description: the type of user that triggered the audit log entry*

          * **enum**
            * *0: Unspecified*

            * *1: System*

            * *2: Employee*

            * *3: Customer*

            * *4: Automation*

            * *5: Studio*

            * *6: CIAutomation*

            * *7: SharedTier*

            * *8: SNIProxy*

            * *9: NimbusGateway*

            * *10: Cluster*

          * *example: Customer*

          * *type: string*

        * **workspaceID**
          * *description: The workspace id tied to this event*

          * *format: uuid*

          * *type: string*

      * *type: object*

    * **AutoScale**
      * *description: Specifies the \[autoscale]\(https\://docs.singlestore.com/cloud/getting-started-with-singlestore-helios/about-workspaces/workspace-scaling/#autoscaling) setting for the workspace.*

      * **properties**
        * **changedAt**
          * *description: Timestamp of last auto-scale configuration change*

          * *format: date-time*

          * *type: string*

        * **lastAutoScaledAt**
          * *description: Timestamp of last auto-scaling event*

          * *format: date-time*

          * *type: string*

        * **maxScaleFactor**
          * *description: The maximum scale factor allowed for the workspace. It can have the following values: 1, 2, or 4. On creation, if not specified, autoscaling is disabled. To disable autoscaling on update, set to 1.*

          * *type: number*

        * **sensitivity**
          * *default: NORMAL*

          * *description: Specifies the sensitivity of the autoscale operation to changes in the workload. It can have the following values: \`LOW\`, \`NORMAL\`, or \`HIGH\`. By default, the sensitivity is set to \`NORMAL\`.*

          * **enum**
            * *0: LOW*

            * *1: NORMAL*

            * *2: HIGH*

          * *example: LOW*

          * *type: string*

      * *type: object*

    * **BillingUsage**
      * *description: Represents the information related to billing usage*

      * **properties**
        * **metric**
          * *description: The metric type*

          * **enum**
            * *0: compute-hour*

          * *type: string*

        * **usage**
          * *description: Usage information*

          * **items**
            * **properties**
              * **endTime**
                * *description: The end time of the interval*

                * *example: 2024-06-01 09:00:00 +0000 UTC*

                * *type: string*

              * **ownerId**
                * *description: ID of the owner of the resource*

                * *example: 78af2f46-0000-1000-9000-3f6f5365d878*

                * *type: string*

              * **resourceId**
                * *description: ID of the resource*

                * *example: 78af2f46-0000-1000-9000-3f6f5365d878*

                * *type: string*

              * **resourceName**
                * *description: Name of the resource*

                * *example: test-workspace*

                * *type: string*

              * **resourceType**
                * *description: The resource type*

                * *example: Workspace*

                * *type: string*

              * **startTime**
                * *description: The start time of the interval*

                * *example: 2024-06-01 08:00:00 +0000 UTC*

                * *type: string*

              * **value**
                * *description: Resource usage value*

                * *example: 30.00*

                * *type: string*

            * *type: object*

          * *type: array*

      * *type: object*

    * **CloudFunctionCreate**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/CloudFunctionFields*

        * **1**
          * **properties**
            * **isAgent**
              * *description: Whether the cloud function runs as an agent*

              * *type: boolean*

          * *type: object*

      * *description: Represents information specified while creating a cloud function*

      * **required**
        * *0: name*

    * **CloudFunctionFields**
      * *description: Common fields for cloud function create and update operations*

      * **properties**
        * **databaseName**
          * *description: Name of the database to connect to*

          * *example: my\_database*

          * *type: string*

        * **description**
          * *description: Description of the cloud function*

          * *example: My custom cloud function*

          * *type: string*

        * **idleTimeoutSeconds**
          * *description: Idle timeout in seconds*

          * *type: integer*

        * **image**
          * *description: Container image to use (mutually exclusive with \`notebookPath\`)*

          * *example: my-registry/my-image:latest*

          * *type: string*

        * **name**
          * *description: Name of the cloud function*

          * *example: my-cloud-function*

          * *type: string*

        * **notebookPath**
          * *description: Path to the notebook file (mutually exclusive with \`image\`)*

          * *example: my-notebook.ipynb*

          * *type: string*

        * **poolName**
          * *description: Nova pool name for execution*

          * *example: my-pool*

          * *type: string*

        * **targetID**
          * *description: Target resource ID (required if \`targetType\` is specified)*

          * *example: 7b68b78d-a000-4000-9000-0864fd331524*

          * *format: uuid*

          * *type: string*

        * **targetType**
          * *description: Type of the target resource (required if \`targetID\` is specified). It can have one of the following values: \`WORKSPACE\`, \`CLUSTER\`, or \`VIRTUAL\_WORKSPACE\`.*

          * **enum**
            * *0: WORKSPACE*

            * *1: CLUSTER*

            * *2: VIRTUAL\_WORKSPACE*

          * *example: WORKSPACE*

          * *type: string*

      * *type: object*

    * **CloudFunctionUpdate**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/CloudFunctionFields*

      * *description: Represents information specified while updating a cloud function*

    * **CloudPrincipal**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/CloudPrincipalIDResponse*

        * **1**
          * *$ref: #/components/schemas/CloudPrincipalUpdate*

        * **2**
          * **properties**
            * **cloudPrincipal**
              * *description: Customer cloud identity bound to this principal.*

              * *example: arn:aws:iam::123456789012:role/IngestionRole*

              * *type: string*

            * **createdBy**
              * *description: Identifier of the user that created the cloud principal.*

              * *format: uuid*

              * *type: string*

            * **email**
              * *description: The generated fake email address for the cloud principal.*

              * *example: cloud-principal-abc123\@service.singlestore.com*

              * *type: string*

          * **required**
            * *0: cloudPrincipal*

            * *1: email*

            * *2: name*

            * *3: description*

          * *type: object*

      * *description: Information about a SingleStoreDB Cloud principal.*

    * **CloudPrincipalCreate**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/CloudPrincipalUpdate*

        * **1**
          * **properties**
            * **cloudPrincipal**
              * *description: Customer cloud identity to bind to this principal.*

              * *example: arn:aws:iam::123456789012:role/IngestionRole*

              * *type: string*

          * **required**
            * *0: name*

            * *1: cloudPrincipal*

          * *type: object*

      * *description: Information specified when creating a cloud principal.*

    * **CloudPrincipalIDResponse**
      * *description: Represents a cloud principal identifier response payload.*

      * **properties**
        * **cloudPrincipalID**
          * *description: Cloud principal identifier.*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: cloudPrincipalID*

      * *type: object*

    * **CloudPrincipalUpdate**
      * *description: Information specified when updating a cloud principal.*

      * **properties**
        * **description**
          * *description: Cloud principal description.*

          * *example: Cloud principal used by ingestion jobs.*

          * *type: string*

        * **name**
          * *description: Cloud principal name.*

          * *example: ingestion-role-renamed*

          * *type: string*

      * *type: object*

    * **CloudProvider**
      * *description: Cloud provider*

      * **enum**
        * *0: AWS*

        * *1: GCP*

        * *2: Azure*

      * *type: string*

    * **CloudWorkloadIdentity**
      * **properties**
        * **identity**
          * *description: The cloud workload identity bound to the workspace group that can be used to access cloud resources. The identity format is determined by the cloud provider where the workspace group is hosted. For example, on AWS it's an IAM role ARN.*

          * *example: arn:aws:iam::123456789012:role/sp5e57fc943d4245dda93431b40f883073*

          * *type: string*

      * **required**
        * *0: identity*

      * *type: object*

    * **ControlAccessAction**
      * **properties**
        * **grants**
          * **items**
            * *$ref: #/components/schemas/ControlAccessRole*

          * *type: array*

        * **revokes**
          * **items**
            * *$ref: #/components/schemas/ControlAccessRole*

          * *type: array*

      * **required**
        * *0: grants*

        * *1: revokes*

      * *type: object*

    * **ControlAccessRole**
      * **properties**
        * **role**
          * *type: string*

        * **teams**
          * **items**
            * *format: uuid*

            * *type: string*

          * *type: array*

        * **users**
          * **items**
            * *format: uuid*

            * *type: string*

          * *type: array*

      * **required**
        * *0: role*

        * *1: teams*

        * *2: users*

      * *type: object*

    * **DelegatedEntitiesAppend**
      * **properties**
        * **entities**
          * *description: List of customer-provided entities (such as IAM role ARNs) to add to the workspace group's delegated entities.*

          * **example**
            * *0: arn:aws:iam::987654321098:role/singlestore-iceberg-readonly*

            * *1: arn:aws:iam::987654321098:role/singlestore-s3-pipelines*

          * **items**
            * *type: string*

          * *type: array*

      * **required**
        * *0: entities*

      * *type: object*

    * **DelegatedEntitiesRemove**
      * **properties**
        * **entities**
          * *description: List of customer-provided entities (such as IAM role ARNs) to remove from the workspace group's delegated entities. If not provided in the request body, entities can be specified via the 'entities' query parameter.*

          * **example**
            * *0: arn:aws:iam::987654321098:role/singlestore-iceberg-readonly*

          * **items**
            * *type: string*

          * *type: array*

      * *type: object*

    * **DelegatedEntity**
      * **properties**
        * **createdAt**
          * *description: Creation timestamp*

          * *format: date-time*

          * *type: string*

        * **entity**
          * *description: The customer-provided entity that the workspace group's cloud workload identity can assume. The entity format is determined by the cloud provider where the workspace group is hosted. For example, on AWS it's a customer-owned IAM role ARN.*

          * *example: arn:aws:iam::987654321098:role/CustomerRole*

          * *type: string*

      * **required**
        * *0: entity*

        * *1: createdAt*

      * *type: object*

    * **EgressClusterIdentityCreate**
      * *description: Represents the information specified to create an export cluster identity*

      * **properties**
        * **catalogInfo**
          * *description: Catalog information for creating the export cluster identity*

          * *type: object*

        * **storageInfo**
          * *description: Storage information for creating the export cluster identity*

          * *type: object*

      * **required**
        * *0: storageInfo*

        * *1: catalogInfo*

      * *type: object*

    * **Execution**
      * **properties**
        * **executionID**
          * *description: The ID of execution*

          * *format: uuid*

          * *type: string*

        * **executionNumber**
          * *description: Number of the execution*

          * *type: number*

        * **finishedAt**
          * *description: Finish time of the execution*

          * *format: date-time*

          * *type: string*

        * **jobID**
          * *description: ID of the job that this execution belongs to*

          * *format: uuid*

          * *type: string*

        * **scheduledStartTime**
          * *description: Scheduled start time of the execution*

          * *format: date-time*

          * *type: string*

        * **snapshotNotebookPath**
          * *description: Path to the notebook which captures the result of this execution*

          * *type: string*

        * **startedAt**
          * *description: Actual start time of the execution*

          * *format: date-time*

          * *type: string*

        * **status**
          * **enum**
            * *0: Unknown*

            * *1: Scheduled*

            * *2: Running*

            * *3: Completed*

            * *4: Failed*

            * *5: Error*

            * *6: Canceled*

          * *example: Scheduled*

          * *type: string*

      * **required**
        * *0: executionID*

        * *1: jobID*

        * *2: status*

        * *3: scheduledStartTime*

        * *4: executionNumber*

      * *type: object*

    * **ExecutionsMetadata**
      * **properties**
        * **endExecutionNumber**
          * *type: number*

        * **startExecutionNumber**
          * *type: number*

      * **required**
        * *0: startExecutionNumber*

        * *1: endExecutionNumber*

      * *type: object*

    * **ExecutionsResult**
      * **properties**
        * **executions**
          * **items**
            * *$ref: #/components/schemas/Execution*

          * *type: array*

        * **executionsMetadata**
          * *$ref: #/components/schemas/ExecutionsMetadata*

      * **required**
        * *0: executions*

        * *1: executionsMetadata*

      * *type: object*

    * **FileLocationSchema**
      * *description: The file location can be one of 'personal', 'shared' or 'models'*

      * **enum**
        * *0: personal*

        * *1: shared*

        * *2: models*

      * *example: personal*

      * *type: string*

    * **FileObjectMetadata**
      * *description: Represents the metadata corresponding to a file object*

      * **properties**
        * **content**
          * **oneOf**
            * **0**
              * *example: Hello World!*

              * *type: string*

            * **1**
              * **example**


              * **items**
                * *$ref: #/components/schemas/FileObjectMetadata*

              * *type: array*

        * **created**
          * *example: 2023-09-08T17:35:43Z*

          * *type: string*

        * **format**
          * *description: Format of the response*

          * **enum**
            * *0: json*

          * *type: string*

        * **last\_modified**
          * *example: 2023-09-08T17:35:43Z*

          * *type: string*

        * **mimetype**
          * *type: string*

        * **name**
          * *description: Name of the file object*

          * *example: file.json*

          * *type: string*

        * **path**
          * *description: Path of the file object*

          * *example: parent\_folder/sample\_folder/file.json*

          * *type: string*

        * **size**
          * *type: integer*

        * **type**
          * *description: Object type*

          * **enum**
            * *0: *

            * *1: json*

            * *2: directory*

          * *type: string*

        * **writable**
          * *type: boolean*

      * *type: object*

    * **Flow**
      * *description: Represents information related to a SingleStore Flow instance*

      * **properties**
        * **createdAt**
          * *description: Timestamp of when the Flow instance was created*

          * *format: date-time*

          * *type: string*

        * **databaseName**
          * *description: Name of the SingleStore database associated with the Flow instance*

          * *type: string*

        * **deletedAt**
          * *description: (If included in the output) The timestamp of when the Flow instance was terminated*

          * *format: date-time*

          * *type: string*

        * **endpoint**
          * *description: Endpoint of the Flow instance*

          * *type: string*

        * **flowID**
          * *description: ID of the Flow instance*

          * *format: uuid*

          * *type: string*

        * **name**
          * *description: Name of the Flow instance*

          * *type: string*

        * **size**
          * *description: Size of the Flow instance (in Flow size notation), such as "F1"*

          * *type: string*

        * **status**
          * *description: Status of the Flow instance, such as whether it is Running or Deleted*

          * *type: string*

        * **userName**
          * *description: Name of the SingleStore database user associated with the Flow instance*

          * *type: string*

        * **workspaceID**
          * *description: ID of the workspace associated with the Flow instance*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: name*

        * *1: flowID*

        * *2: createdAt*

      * *type: object*

    * **FlowCreate**
      * *description: Represents the information specified while creating a SingleStore Flow instance*

      * **properties**
        * **databaseName**
          * *description: Name of the SingleStore database to connect to*

          * *example: database\_1*

          * *type: string*

        * **name**
          * *description: Name of the Flow instance*

          * *example: flow-instance-1*

          * *type: string*

        * **size**
          * *description: Size of the Flow instance (in Flow size notation), such as "F1"*

          * *example: F2*

          * *type: string*

        * **userName**
          * *description: Username of the SingleStore database user with which to connect to the SingleStore database*

          * *example: admin*

          * *type: string*

        * **workspaceID**
          * *description: The ID of the workspace to associate the Flow instance with*

          * *example: 7d6b3a5a-0000-1000-9000-d454af4c785b*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: name*

        * *1: workspaceID*

        * *2: userName*

        * *3: databaseName*

      * *type: object*

    * **IdentityRole**
      * **properties**
        * **resourceID**
          * *description: The resource id*

          * *format: uuid*

          * *type: string*

        * **resourceType**
          * *description: The resource type*

          * *type: string*

        * **role**
          * *description: The role can access the resource*

          * *type: string*

      * **required**
        * *0: role*

        * *1: resourceType*

        * *2: resourceID*

      * *type: object*

    * **Job**
      * **properties**
        * **completedExecutionsCount**
          * *description: Count of completed executions for the job*

          * *type: integer*

        * **createdAt**
          * *description: Creation time of the job*

          * *format: date-time*

          * *type: string*

        * **description**
          * *description: Description of the job*

          * *example: Sample Description*

          * *type: string*

        * **enqueuedBy**
          * *description: ID of the user who created the job*

          * *format: uuid*

          * *type: string*

        * **executionConfig**
          * *$ref: #/components/schemas/JobExecutionConfig*

        * **jobID**
          * *description: ID of the job*

          * *format: uuid*

          * *type: string*

        * **jobMetadata**
          * *description: Array containing information about the max/avg execution duration and the number of executions with a particular status for the job*

          * **items**
            * *$ref: #/components/schemas/JobMetadata*

          * *type: array*

        * **name**
          * *description: Name of the job*

          * *example: Sample Job*

          * *type: string*

        * **schedule**
          * *$ref: #/components/schemas/JobSchedule*

        * **targetConfig**
          * *$ref: #/components/schemas/JobTargetConfig*

        * **terminatedAt**
          * *description: Termination time of the job*

          * *format: date-time*

          * *type: string*

      * **required**
        * *0: jobID*

        * *1: enqueuedBy*

        * *2: executionConfig*

        * *3: schedule*

        * *4: createdAt*

        * *5: completedExecutionsCount*

        * *6: jobMetadata*

      * *type: object*

    * **JobCreate**
      * *description: Represents the information specified when creating a job.*

      * **properties**
        * **description**
          * *description: Description of the job*

          * *example: Job Description*

          * *type: string*

        * **executionConfig**
          * **properties**
            * **createSnapshot**
              * *description: Indicates whether the job will save snapshots*

              * *type: boolean*

            * **notebookPath**
              * *description: Path to the shared notebook file that contains the code that needs to be run on a schedule as part of this job*

              * *example: sample\_notebook.ipynb*

              * *type: string*

            * **runtimeName**
              * *description: Name of the runtime*

              * *example: notebooks-cpu-small*

              * *type: string*

          * **required**
            * *0: notebookPath*

            * *1: createSnapshot*

          * *type: object*

        * **name**
          * *description: Name of the job*

          * *example: Job Name*

          * *type: string*

        * **parameters**
          * *description: Array containing the parameters for the job*

          * **items**
            * *$ref: #/components/schemas/JobParameter*

          * *type: array*

        * **schedule**
          * *$ref: #/components/schemas/JobSchedule*

        * **targetConfig**
          * *$ref: #/components/schemas/JobTargetConfig*

      * **required**
        * *0: name*

        * *1: executionConfig*

        * *2: schedule*

      * *type: object*

    * **JobExecutionConfig**
      * **properties**
        * **createSnapshot**
          * *description: Indicates whether the job will save snapshots*

          * *type: boolean*

        * **maxAllowedExecutionDurationInMinutes**
          * *description: Maximum allowed execution duration for the job in minutes*

          * *type: integer*

        * **notebookPath**
          * *description: Path to the shared notebook file that contains the code that needs to be run on a schedule as part of this job*

          * *example: sample\_notebook.ipynb*

          * *type: string*

      * **required**
        * *0: notebookPath*

        * *1: createSnapshot*

        * *2: maxAllowedExecutionDurationInMinutes*

      * *type: object*

    * **JobMetadata**
      * **properties**
        * **avgDurationInSeconds**
          * *description: Average duration of executions (in seconds) with the corresponding status*

          * *format: float*

          * *type: number*

        * **count**
          * *description: The number of executions with the corresponding status*

          * *type: integer*

        * **maxDurationInSeconds**
          * *description: Maximum duration of executions (in seconds) with the corresponding status*

          * *format: float*

          * *type: number*

        * **status**
          * **enum**
            * *0: Unknown*

            * *1: Scheduled*

            * *2: Running*

            * *3: Completed*

            * *4: Failed*

            * *5: Error*

            * *6: Canceled*

          * *example: Completed*

          * *type: string*

      * **required**
        * *0: status*

        * *1: count*

      * *type: object*

    * **JobParameter**
      * **properties**
        * **name**
          * *description: Name of the parameter*

          * *example: foo*

          * *type: string*

        * **type**
          * *description: Type of the parameter*

          * **enum**
            * *0: string*

            * *1: integer*

            * *2: float*

            * *3: boolean*

          * *example: integer*

          * *type: string*

        * **value**
          * *description: Value of the parameter*

          * *example: 10*

          * *type: string*

      * **required**
        * *0: name*

        * *1: value*

        * *2: type*

      * *type: object*

    * **JobSchedule**
      * **properties**
        * **executionIntervalInMinutes**
          * *description: The time interval between executions of this job. This is required for a Recurring job.*

          * *type: integer*

        * **mode**
          * **enum**
            * *0: Recurring*

            * *1: Once*

          * *type: string*

        * **startAt**
          * *description: The time at which the first execution of this job should begin.*

          * *format: date-time*

          * *type: string*

      * **required**
        * *0: mode*

      * *type: object*

    * **JobTargetConfig**
      * **properties**
        * **databaseName**
          * *description: Name of the database*

          * *example: sample\_db*

          * *type: string*

        * **resumeTarget**
          * *description: Indicates whether executions of this job will resume the target associated with the job, if it is suspended*

          * *type: boolean*

        * **targetID**
          * *description: The target ID for the job, this could be the ID of Workspace, Cluster or VirtualWorkspace (in case of shared-tier).*

          * *format: uuid*

          * *type: string*

        * **targetType**
          * **enum**
            * *0: Workspace*

            * *1: Cluster*

            * *2: VirtualWorkspace*

          * *type: string*

      * **required**
        * *0: targetType*

        * *1: targetID*

        * *2: resumeTarget*

      * *type: object*

    * **Model**
      * **properties**
        * **connectionURL**
          * *description: Model base url*

          * *type: string*

        * **modelName**
          * *description: Name or ID of the model*

          * *type: string*

        * **name**
          * *description: Name of the Model*

          * *type: string*

        * **serviceID**
          * *description: Model ID*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: serviceID*

        * *1: name*

        * *2: connectionURL*

        * *3: modelName*

      * *type: object*

    * **ModelStart**
      * **properties**
        * **hostingPlatform**
          * *description: Platform hosting the model*

          * **enum**
            * *0: Nova*

            * *1: Amazon*

            * *2: Azure*

          * *example: Nova*

          * *type: string*

        * **modelID**
          * *description: ID of the model*

          * *type: string*

        * **modelName**
          * *description: Name of the model*

          * *type: string*

        * **rawConnectionURL**
          * *description: Direct connection URL to the model service*

          * *type: string*

        * **version**
          * *description: Version of the model*

          * *type: string*

      * **required**
        * *0: modelName*

        * *1: modelID*

        * *2: version*

        * *3: hostingPlatform*

        * *4: rawConnectionURL*

      * *type: object*

    * **NotebookCloudFunction**
      * *description: A cloud function resource*

      * **properties**
        * **createdAt**
          * *description: Timestamp of when the cloud function was created*

          * *example: 2025-08-08T13:41:45.835577Z*

          * *format: date-time*

          * *type: string*

        * **createdBy**
          * *description: ID of the user that created the cloud function*

          * *example: 41e2268a-b000-4000-9000-4ed98936a401*

          * *format: uuid*

          * *type: string*

        * **description**
          * *description: Description of the cloud function*

          * *example: My custom cloud function*

          * *type: string*

        * **endpoint**
          * *description: The endpoint URL for invoking the cloud function*

          * *example: https\://app.singlestore.com/functions/7b68b78d-a000-4000-9000-0864fd331524/*

          * *type: string*

        * **lastUpdatedAt**
          * *description: Timestamp of when the cloud function was last updated*

          * *example: 2025-08-09T10:20:30.123456Z*

          * *format: date-time*

          * *type: string*

        * **name**
          * *description: Name of the cloud function*

          * *example: my-cloud-function*

          * *type: string*

        * **serviceID**
          * *description: Unique identifier for the cloud function*

          * *example: 7b68b78d-a000-4000-9000-0864fd331524*

          * *format: uuid*

          * *type: string*

        * **status**
          * *description: Current status of the cloud function*

          * **enum**
            * *0: Initializing*

            * *1: Active*

            * *2: Failed*

            * *3: Deleted*

            * *4: Idle*

          * *example: Initializing*

          * *type: string*

      * **required**
        * *0: serviceID*

        * *1: name*

        * *2: status*

        * *3: createdBy*

        * *4: createdAt*

      * *type: object*

    * **NotebookCloudFunctionPaginationMetadata**
      * *description: Pagination metadata for the cloud functions list*

      * **properties**
        * **count**
          * *description: Number of cloud functions in the current page*

          * *type: integer*

        * **hasNextPage**
          * *description: Indicates if there is a next page*

          * *type: boolean*

        * **hasPreviousPage**
          * *description: Indicates if there is a previous page*

          * *type: boolean*

        * **totalCount**
          * *description: Total number of cloud functions*

          * *type: integer*

      * **required**
        * *0: count*

        * *1: hasPreviousPage*

        * *2: hasNextPage*

        * *3: totalCount*

      * *type: object*

    * **Organization**
      * *description: Represents information related to an organization*

      * **properties**
        * **firewallRanges**
          * *description: The list of allowed IP addresses which can access the Management API*

          * **items**
            * *type: string*

          * *type: array*

        * **name**
          * *description: Name of the organization*

          * *type: string*

        * **orgID**
          * *description: ID of the organization*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: orgID*

      * *type: object*

    * **PermissionDefinition**
      * **properties**
        * **description**
          * *description: Permission description*

          * *type: string*

        * **permission**
          * *description: Permission name*

          * *type: string*

        * **resourceType**
          * *description: Resource type for the permission*

          * *type: string*

      * **required**
        * *0: permission*

        * *1: resourceType*

      * *type: object*

    * **PermissionsForResourceType**
      * **properties**
        * **permissions**
          * *description: The permissions of the resource type on the role*

          * **items**
            * *type: string*

          * *type: array*

        * **resourceType**
          * *description: Resource type*

          * *type: string*

      * **required**
        * *0: resourceType*

        * *1: permissions*

      * *type: object*

    * **PermissionsSpecification**
      * **properties**
        * **permissions**
          * *description: The permissions of the resource type on the role*

          * **items**
            * *type: string*

          * *type: array*

        * **resourceType**
          * *description: Resource type*

          * *type: string*

      * **required**
        * *0: resourceType*

        * *1: permissions*

      * *type: object*

    * **PrivateConnection**
      * *description: Represents information related to a private link connection*

      * **properties**
        * **activeAt**
          * *description: The timestamp of when the private connection became active*

          * *example: 2023-09-18T09:56:56Z*

          * *type: string*

        * **allowList**
          * *description: The private connection allow list. This is the account ID for AWS,  subscription ID for Azure, and the project name GCP*

          * *example: my-allow-list*

          * *type: string*

        * **allowedPrivateLinkIDs**
          * **items**
            * *description: Allowed Private Link ID*

            * *example: vpce-01a376f2625261f22*

            * *type: string*

          * *type: array*

        * **createdAt**
          * *description: The timestamp of when the private connection was created*

          * *example: 2023-09-18T09:56:56Z*

          * *type: string*

        * **deletedAt**
          * *description: The timestamp of when the private connection was deleted*

          * *example: 2023-09-18T09:56:56Z*

          * *type: string*

        * **endpoint**
          * *description: The service endpoint*

          * *example: com.amazonaws.vpce.us-east-1.vpce-svc-08e20961f648f9d*

          * *type: string*

        * **outboundAllowList**
          * *description: The account ID which must be allowed for outbound connections*

          * *example: arn:aws:iam:xxxxxxxxx:root*

          * *type: string*

        * **privateConnectionID**
          * *description: The ID of the private connection*

          * *example: 8900372e-0000-1000-9000-4c47638040af*

          * *format: uuid*

          * *type: string*

        * **serviceName**
          * *description: The name of the private connection service*

          * *example: My service*

          * *type: string*

        * **sqlPort**
          * *description: The SQL port*

          * *type: number*

        * **status**
          * *description: The status of the private connection*

          * **enum**
            * *0: PENDING*

            * *1: ACTIVE*

            * *2: DELETED*

          * *example: ACTIVE*

          * *type: string*

        * **type**
          * *description: The private connection type*

          * **enum**
            * *0: INBOUND*

            * *1: OUTBOUND*

          * *example: INBOUND*

          * *type: string*

        * **updatedAt**
          * *description: The timestamp of when the private connection was last updated*

          * *example: 2023-09-18T09:56:56Z*

          * *type: string*

        * **websocketsPort**
          * *description: The websockets port*

          * *type: number*

        * **workspaceGroupID**
          * *description: The ID of the workspace group containing the private connection*

          * *example: 68af2f46-0000-1000-9000-3f6f5365d878*

          * *format: uuid*

          * *type: string*

        * **workspaceID**
          * *description: The ID of the workspace to connect with*

          * *example: 7d6b3a5a-0000-1000-9000-d454af4c785b*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: privateConnectionID*

        * *1: workspaceGroupID*

      * *type: object*

    * **PrivateConnectionCreate**
      * *description: Represents the information specified when creating a private connection*

      * **properties**
        * **allowList**
          * *description: The private connection allow list*

          * *example: my-allow-list*

          * *type: string*

        * **kaiEndpointID**
          * *description: VPC Endpoint ID for AWS*

          * *example: vpce-12345678901234567*

          * *type: string*

        * **serviceName**
          * *description: The name of the private connection service*

          * *example: My private link*

          * *type: string*

        * **sqlPort**
          * *description: The SQL port*

          * *type: number*

        * **type**
          * *description: The private connection type*

          * **enum**
            * *0: INBOUND*

            * *1: OUTBOUND*

          * *example: INBOUND*

          * *type: string*

        * **websocketsPort**
          * *description: The websockets port*

          * *type: number*

        * **workspaceGroupID**
          * *description: The ID of the workspace group containing the private connection*

          * *example: 68af2f46-0000-1000-9000-3f6f5365d878*

          * *format: uuid*

          * *type: string*

        * **workspaceID**
          * *description: The ID of the workspace to connect with*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: workspaceGroupID*

      * *type: object*

    * **PrivateConnectionKaiInfo**
      * *description: Represents the information for creating private connection to SingleStore Kai*

      * **properties**
        * **serviceName**
          * *description: VPC Endpoint Service Name for AWS*

          * *example: com.amazonaws.vpce.us-east-1.vpce-svc-0123456789abcdefg*

          * *type: string*

      * *type: object*

    * **PrivateConnectionOutboundAllowList**
      * *description: Represents information related to a private connection outbound allow list*

      * **properties**
        * **outboundAllowList**
          * *description: The account ID allowed for outbound connections*

          * *example: arn:aws:iam:xxxxxxxxx:root*

          * *type: string*

      * *type: object*

    * **PrivateConnectionUpdate**
      * *description: Represents the information specfied when updating a private connection*

      * **properties**
        * **allowList**
          * *description: The private connection allow list*

          * *example: my-allow-list*

          * *type: string*

      * *type: object*

    * **Project**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/ProjectIDResponse*

        * **1**
          * *$ref: #/components/schemas/ProjectCreate*

        * **2**
          * **properties**
            * **createdAt**
              * *description: The timestamp of when the project was created*

              * *format: date-time*

              * *type: string*

          * **required**
            * *0: createdAt*

          * *type: object*

      * *description: Full project representation*

    * **ProjectCreate**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/ProjectUpdate*

        * **1**
          * **properties**
            * **edition**
              * *$ref: #/components/schemas/ProjectEdition*

          * **required**
            * *0: edition*

          * *type: object*

      * *description: Request body for creating a project*

    * **ProjectEdition**
      * *description: Edition of the project*

      * **enum**
        * *0: STANDARD*

        * *1: ENTERPRISE*

        * *2: PREMIUM*

        * *3: DEDICATED*

        * *4: SHARED*

      * *type: string*

    * **ProjectIDResponse**
      * *description: Represents the project identifier response payload*

      * **properties**
        * **projectID**
          * *format: uuid*

          * *type: string*

      * **required**
        * *0: projectID*

      * *type: object*

    * **ProjectUpdate**
      * *description: Request body for updating a project*

      * **properties**
        * **name**
          * *description: Name of the project*

          * *type: string*

      * **required**
        * *0: name*

      * *type: object*

    * **Region**
      * *description: Represents information related to a region in which a workspace group is created*

      * **properties**
        * **provider**
          * *$ref: #/components/schemas/CloudProvider*

        * **region**
          * *description: Name of the region*

          * *type: string*

        * **regionID**
          * *description: ID of the region*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: regionID*

        * *1: region*

        * *2: provider*

      * *type: object*

    * **RegionV2**
      * *description: Represents information related to a region in which a workspace group is created*

      * **properties**
        * **provider**
          * *$ref: #/components/schemas/CloudProvider*

        * **region**
          * *description: Name of the region*

          * *type: string*

        * **regionName**
          * *description: The region code name*

          * *type: string*

      * **required**
        * *0: region*

        * *1: provider*

        * *2: regionName*

      * *type: object*

    * **ReplicatedDatabase**
      * *description: Represents information related to a database's replication status*

      * **properties**
        * **databaseName**
          * *description: Name of the database*

          * *type: string*

        * **duplicationState**
          * *description: Duplication state of the database*

          * **enum**
            * *0: Pending*

            * *1: Active*

            * *2: Inactive*

            * *3: Error*

          * *type: string*

        * **region**
          * *description: Name of the region*

          * *type: string*

      * **required**
        * *0: databaseName*

        * *1: region*

        * *2: duplicationState*

      * *type: object*

    * **ResourceRole**
      * **properties**
        * **description**
          * *description: the description about the role*

          * *type: string*

        * **grants**
          * **items**
            * *$ref: #/components/schemas/ResourceRoleGrant*

          * *type: array*

        * **role**
          * *description: the role can access the resource*

          * *type: string*

      * **required**
        * *0: role*

        * *1: description*

        * *2: grants*

      * *type: object*

    * **ResourceRoleGrant**
      * **properties**
        * **createdAt**
          * *description: Creation timestamp*

          * *format: date-time*

          * *type: string*

        * **createdBy**
          * *$ref: #/components/schemas/UserInfo*

        * **identity**
          * **oneOf**
            * **0**
              * *$ref: #/components/schemas/UserInfo*

            * **1**
              * *$ref: #/components/schemas/TeamInfo*

        * **inheritedFrom**
          * **properties**
            * **resourceID**
              * *description: ID of the resource*

              * *format: uuid*

              * *type: string*

            * **resourceType**
              * *type: string*

            * **role**
              * *type: string*

          * **required**
            * *0: role*

            * *1: resourceType*

            * *2: resourceID*

          * *type: object*

      * **required**
        * *0: identity*

        * *1: createdAt*

      * *type: object*

    * **RetentionPeriodParams**
      * *description: Represents the information to be specified when updating the retention period of a workspace group.*

      * **properties**
        * **retentionPeriod**
          * *description: Retention period in minutes*

          * *type: integer*

      * **required**
        * *0: retentionPeriod*

      * *type: object*

    * **RoleCreate**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/RoleUpdate*

        * **1**
          * **properties**
            * **role**
              * *description: The name for the custom role*

              * *type: string*

          * **required**
            * *0: role*

          * *type: object*

    * **RoleCreateV2**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/RoleReplaceV2*

        * **1**
          * **properties**
            * **role**
              * *description: The name for the custom role*

              * *type: string*

          * **required**
            * *0: role*

          * *type: object*

    * **RoleDefinition**
      * **properties**
        * **createdAt**
          * *description: Creation timestamp.*

          * *format: date-time*

          * *type: string*

        * **createdBy**
          * *$ref: #/components/schemas/UserInfo*

        * **description**
          * *description: A description of the role*

          * *type: string*

        * **inherits**
          * *description: The roles that current role will inherit from*

          * **items**
            * *$ref: #/components/schemas/TypedRole*

          * *type: array*

        * **isCustom**
          * *description: Indicate the role is a custom role*

          * *type: boolean*

        * **permissions**
          * *description: The permissions that the role has*

          * **items**
            * *type: string*

          * *type: array*

        * **resourceType**
          * *description: The resource type for the role*

          * *type: string*

        * **role**
          * *description: The role name*

          * *type: string*

        * **updatedAt**
          * *description: Timestamp of most recent state change.*

          * *format: date-time*

          * *type: string*

        * **updatedBy**
          * *$ref: #/components/schemas/UserInfo*

      * **required**
        * *0: role*

        * *1: resourceType*

        * *2: permissions*

        * *3: isCustom*

        * *4: inherits*

      * *type: object*

    * **RoleDefinitionV2**
      * **properties**
        * **createdAt**
          * *description: Creation timestamp.*

          * *format: date-time*

          * *type: string*

        * **createdBy**
          * *$ref: #/components/schemas/UserInfo*

        * **description**
          * *description: A description of the role*

          * *type: string*

        * **permissions**
          * *description: Permissions for the role definition*

          * **items**
            * *$ref: #/components/schemas/PermissionsForResourceType*

          * *type: array*

        * **role**
          * *description: The role name*

          * *type: string*

        * **updatedAt**
          * *description: Timestamp of most recent state change.*

          * *format: date-time*

          * *type: string*

        * **updatedBy**
          * *$ref: #/components/schemas/UserInfo*

      * **required**
        * *0: role*

        * *1: permissions*

      * *type: object*

    * **RoleReplaceV2**
      * **properties**
        * **description**
          * *description: A description of the role*

          * *type: string*

        * **permissions**
          * *description: All permissions defined for the role to be replaced*

          * **items**
            * *$ref: #/components/schemas/PermissionsSpecification*

          * *type: array*

        * **role**
          * *description: Optional role name and must match the role path parameter when provided*

          * *type: string*

      * **required**
        * *0: permissions*

      * *type: object*

    * **RoleUpdate**
      * **properties**
        * **description**
          * *description: A description of the role*

          * *type: string*

        * **inherits**
          * *description: The roles that the current role will inherit from*

          * **items**
            * *$ref: #/components/schemas/TypedRole*

          * *type: array*

        * **permissions**
          * *description: The permissions are seperated by the resourceType, like you can put 'View Storage' DR for 'Cluster' resourceType but not 'Organization'*

          * **items**
            * *type: string*

          * *type: array*

      * **required**
        * *0: permissions*

        * *1: inherits*

      * *type: object*

    * **RuntimesResult**
      * **properties**
        * **description**
          * *description: The description of the runtime*

          * *example: 1750m vCPU | 15Gi*

          * *type: string*

        * **name**
          * *description: The name of the runtime*

          * *example: notebooks-cpu-small*

          * *type: string*

      * **required**
        * *0: name*

        * *1: description*

      * *type: object*

    * **Secret**
      * *description: Represents information related to SingleStore Helios secrets.*

      * **properties**
        * **createdAt**
          * *description: The timestamp of when the secret was created.*

          * *example: 2023-09-18T09:56:56Z*

          * *type: string*

        * **createdBy**
          * *description: The ID of the user that created the secret.*

          * *example: 17290909-0000-1000-9000-e30410f1b05a*

          * *format: uuid*

          * *type: string*

        * **deletedAt**
          * *description: The timestamp of when the secret was deleted.*

          * *example: 2023-09-18T09:56:56Z*

          * *type: string*

        * **deletedBy**
          * *description: The ID of the user that deleted the secret.*

          * *example: 17290909-0000-1000-9000-e30410f1b05a*

          * *format: uuid*

          * *type: string*

        * **lastUpdatedAt**
          * *description: The timestamp of when the secret was last updated.*

          * *example: 2023-09-18T09:56:56Z*

          * *type: string*

        * **lastUpdatedBy**
          * *description: The ID of the user that last updated the secret.*

          * *example: 17290909-0000-1000-9000-e30410f1b05a*

          * *format: uuid*

          * *type: string*

        * **name**
          * *description: The name of the secret. It can only contain alphanumeric characters or underscores.*

          * *example: my\_secret*

          * *type: string*

        * **secretID**
          * *description: The ID of the secret.*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *format: uuid*

          * *type: string*

        * **value**
          * *description: The value of the secret.*

          * *example: my\_secret\_value*

          * *type: string*

      * **required**
        * *0: secretID*

        * *1: name*

        * *2: createdAt*

        * *3: createdBy*

        * *4: lastUpdatedAt*

        * *5: lastUpdatedBy*

      * *type: object*

    * **SecretCreate**
      * *description: Represents the information specified when creating a secret.*

      * **properties**
        * **name**
          * *description: The name of the secret. It can only contain alphanumeric characters or underscores.*

          * *example: my\_secret*

          * *type: string*

        * **value**
          * *description: The value of the secret.*

          * *example: my\_secret\_value*

          * *type: string*

      * **required**
        * *0: name*

        * *1: value*

      * *type: object*

    * **SecretUpdate**
      * *description: Represents the information specified when updating a secret.*

      * **properties**
        * **value**
          * *description: The value of the secret.*

          * *example: my\_secret\_value*

          * *type: string*

      * *type: object*

    * **ServiceAccount**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/ServiceAccountIDResponse*

        * **1**
          * *$ref: #/components/schemas/ServiceAccountUpdate*

        * **2**
          * **properties**
            * **createdBy**
              * *description: Identifier of the user that created the service account.*

              * *format: uuid*

              * *type: string*

            * **email**
              * *description: The generated fake email address for the service account.*

              * *example: service-account-abc123\@service.singlestore.com*

              * *type: string*

          * **required**
            * *0: email*

            * *1: name*

            * *2: description*

          * *type: object*

      * *description: Information about a SingleStoreDB Cloud service account.*

    * **ServiceAccountCreate**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/ServiceAccountUpdate*

        * **1**
          * **required**
            * *0: name*

          * *type: object*

      * *description: Information specified when creating a service account.*

    * **ServiceAccountIDResponse**
      * *description: Represents a service account identifier response payload.*

      * **properties**
        * **serviceAccountID**
          * *description: Service account identifier.*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: serviceAccountID*

      * *type: object*

    * **ServiceAccountUpdate**
      * *description: Information specified when updating a service account.*

      * **properties**
        * **description**
          * *description: Service account description.*

          * *example: Service account used by ingestion jobs.*

          * *type: string*

        * **name**
          * *description: Service account name.*

          * *example: ingestion-service-renamed*

          * *type: string*

      * *type: object*

    * **SharedTierCreateUser**
      * *description: Represents the information specified when creating a user in a shared tier workspace*

      * **properties**
        * **password**
          * *description: The starter workspace user password to connect the new user to the database.*

          * *example: My-password1!*

          * *type: string*

        * **userName**
          * *description: The starter workspace user name to connect the new user to the database*

          * *example: new-user*

          * *type: string*

      * **required**
        * *0: userName*

      * *type: object*

    * **SharedTierCreateVirtualCluster**
      * **properties**
        * **databaseName**
          * *description: Name of the database*

          * *example: database\_60c6b*

          * *type: string*

        * **name**
          * *description: Name of the starter cluster*

          * *example: starter-cluster-1*

          * *type: string*

        * **projectID**
          * *description: Assigns the starter cluster to a project*

          * *example: 2d7bd375-6303-46c4-903a-8a3d5b4922c0*

          * *format: uuid*

          * *type: string*

        * **provider**
          * *description: Name of the provider*

          * **enum**
            * *0: AWS*

            * *1: GCP*

            * *2: AZURE*

          * *type: string*

        * **regionName**
          * *description: The region code*

          * *example: us-east-1*

          * *type: string*

      * **required**
        * *0: name*

        * *1: databaseName*

        * *2: provider*

        * *3: regionName*

      * *type: object*

    * **SharedTierCreateVirtualWorkspace**
      * **properties**
        * **databaseName**
          * *description: Name of the database*

          * *example: database\_60c6b*

          * *type: string*

        * **name**
          * *description: Name of the shared workspace*

          * *example: shared-workspace-1*

          * *type: string*

        * **projectID**
          * *description: Assigns the shared workspace to a project*

          * *example: 2d7bd375-6303-46c4-903a-8a3d5b4922c0*

          * *format: uuid*

          * *type: string*

        * **provider**
          * *description: Name of the provider*

          * **enum**
            * *0: AWS*

            * *1: GCP*

            * *2: AZURE*

          * *type: string*

        * **regionName**
          * *description: The region code*

          * *example: us-east-1*

          * *type: string*

      * **required**
        * *0: name*

        * *1: databaseName*

        * *2: provider*

        * *3: regionName*

      * *type: object*

    * **SharedTierMigrateStatusV2**
      * *description: Represents the information related to the migration of a Shared Edition deployment (starter cluster) to a cluster group*

      * **properties**
        * **clusterID**
          * *description: ID of the new cluster*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *format: uuid*

          * *type: string*

        * **migratedScheduledJobs**
          * *description: Indicates whether the migration operation included scheduled jobs.*

          * *type: boolean*

        * **migrationStatus**
          * *description: Status of the migration operation*

          * **enum**
            * *0: PENDING*

            * *1: SUCCEEDED*

            * *2: FAILED*

          * *example: SUCCEEDED*

          * *type: string*

      * **required**
        * *0: migrationStatus*

        * *1: clusterID*

        * *2: migratedScheduledJobs*

      * *type: object*

    * **SharedTierUpdateUser**
      * *description: Represents the information specified when updating a user in a shared tier workspace*

      * **properties**
        * **password**
          * *description: The virtual workspace user password to connect the new user to the database.*

          * *example: My-password1!*

          * *type: string*

      * *type: object*

    * **SharedTierVirtualCluster**
      * **properties**
        * **databaseName**
          * *description: Name of the database*

          * *example: database\_60c6b*

          * *type: string*

        * **endpoint**
          * *description: The application endpoint of the SingleStore database*

          * *example: svc-3482219c-a389-4079-b18b-d50662524e8a-shared-dml.aws-virginia-6.svc.singlestore.com:3333*

          * *type: string*

        * **mysqlDmlPort**
          * *description: The MySQL DML port*

          * *type: integer*

        * **name**
          * *description: Name of the starter cluster*

          * *example: starter-cluster-1*

          * *type: string*

        * **projectID**
          * *description: ID of the project to which the virtual cluster is assigned.*

          * *example: 2d7bd375-0000-1000-9000-8a3d5b4922c0*

          * *format: uuid*

          * *type: string*

        * **virtualClusterID**
          * *description: ID of the starter cluster*

          * *format: uuid*

          * *type: string*

        * **websocketPort**
          * *description: The websockets port*

          * *type: integer*

      * *type: object*

    * **SharedTierVirtualWorkspace**
      * **properties**
        * **databaseName**
          * *description: Name of the database*

          * *example: database\_60c6b*

          * *type: string*

        * **endpoint**
          * *description: The application endpoint of the SingleStore database*

          * *example: svc-3482219c-a389-4079-b18b-d50662524e8a-shared-dml.aws-virginia-6.svc.singlestore.com:3333*

          * *type: string*

        * **mysqlDmlPort**
          * *description: The MySQL DML port*

          * *type: integer*

        * **name**
          * *description: Name of the starter workspace*

          * *example: starter-workspace-1*

          * *type: string*

        * **projectID**
          * *description: ID of the project to which the virtual workspace is assigned.*

          * *example: 2d7bd375-0000-1000-9000-8a3d5b4922c0*

          * *format: uuid*

          * *type: string*

        * **virtualWorkspaceID**
          * *description: ID of the starter workspace*

          * *format: uuid*

          * *type: string*

        * **websocketPort**
          * *description: The websockets port*

          * *type: integer*

      * *type: object*

    * **SimulateUsageRequest**
      * *description: Request body for simulating billing usage*

      * **example**
        * *endBefore: 2024-01-31T23:59:59Z*

        * **resourceConfigurations**
          * **0**
            * *edition: Standard*

            * *endBefore: 2024-01-31T23:59:59Z*

            * *id: 7d6b3a5a-0000-1000-9000-d454af4c785b*

            * *size: S-1*

            * *startAt: 2024-01-01T00:00:00Z*

            * *status: Active*

        * *startAt: 2024-01-01T00:00:00Z*

      * **properties**
        * **endBefore**
          * *description: The end time of the simulation period (must be after startAt)*

          * *example: 2024-06-02T08:00:00Z*

          * *format: date-time*

          * *type: string*

        * **resourceConfigurations**
          * *description: Array of resource configurations to simulate*

          * **items**
            * *$ref: #/components/schemas/SimulationResourceConfig*

          * *type: array*

        * **startAt**
          * *description: The start time of the simulation period*

          * *example: 2024-06-01T08:00:00Z*

          * *format: date-time*

          * *type: string*

      * **required**
        * *0: startAt*

        * *1: endBefore*

        * *2: resourceConfigurations*

      * *type: object*

    * **SimulateUsageResponse**
      * *description: Response containing simulated usage data*

      * **properties**
        * **resourceUsage**
          * *description: Array of simulated resource usage entries*

          * **items**
            * *$ref: #/components/schemas/SimulatedResourceUsage*

          * *type: array*

      * *type: object*

    * **SimulatedResourceUsage**
      * *description: Simulated usage data for a single resource*

      * **example**
        * *endBefore: 2024-01-31T23:59:59Z*

        * *id: 7d6b3a5a-0000-1000-9000-d454af4c785b*

        * *metric: ComputeHour*

        * *name: test-workspace*

        * *startAt: 2024-01-01T00:00:00Z*

        * *type: Workspace*

      * **properties**
        * **amount**
          * *description: The computed usage amount*

          * *format: double*

          * *type: number*

        * **endBefore**
          * *description: The end time of the usage period (optional)*

          * *format: date-time*

          * *type: string*

        * **id**
          * *description: The ID of the resource*

          * *format: uuid*

          * *type: string*

        * **metric**
          * *description: The metric used to measure usage (optional)*

          * **enum**
            * *0: ComputeHour*

          * *type: string*

        * **name**
          * *description: The name of the resource (optional)*

          * *type: string*

        * **parentID**
          * *description: The ID of the parent resource (optional)*

          * *format: uuid*

          * *type: string*

        * **startAt**
          * *description: The start time of the usage period (optional)*

          * *format: date-time*

          * *type: string*

        * **type**
          * *description: The type of resource (optional)*

          * **enum**
            * *0: Cluster*

            * *1: Workspace*

            * *2: WorkspaceGroup*

          * *type: string*

      * **required**
        * *0: id*

        * *1: amount*

      * *type: object*

    * **SimulationResourceConfig**
      * *description: Configuration for a simulated resource*

      * **properties**
        * **cacheMultiplier**
          * *description: The cache multiplier (optional)*

          * **enum**
            * *0: X1*

            * *1: X2*

            * *2: X4*

          * *type: string*

        * **cellID**
          * *description: The ID of the cell (optional)*

          * *format: uuid*

          * *type: string*

        * **edition**
          * *description: The edition of the resource (optional)*

          * **enum**
            * *0: Standard*

            * *1: Enterprise*

            * *2: Dedicated*

          * *type: string*

        * **endBefore**
          * *description: The end time for this resource configuration*

          * *format: date-time*

          * *type: string*

        * **id**
          * *description: The ID of the resource*

          * *format: uuid*

          * *type: string*

        * **multiAZ**
          * *description: Whether the resource uses multiple availability zones (optional)*

          * *type: boolean*

        * **scaleFactor**
          * *description: The scale factor (optional)*

          * **enum**
            * *0: X1*

            * *1: X2*

            * *2: X4*

          * *type: string*

        * **size**
          * *description: The size of the resource, e.g., S-00, S-1, S-2 (optional)*

          * *type: string*

        * **startAt**
          * *description: The start time for this resource configuration*

          * *format: date-time*

          * *type: string*

        * **status**
          * *description: The status of the resource (optional)*

          * **enum**
            * *0: Active*

            * *1: Paused*

            * *2: Terminated*

          * *type: string*

      * **required**
        * *0: id*

        * *1: startAt*

        * *2: endBefore*

      * *type: object*

    * **StorageDRSetup**
      * *description: Represents the information specified to setup Storage DR*

      * **properties**
        * **autoReplication**
          * *description: If set to true, all existing and future databases created will be automatically replicated to the secondary region. If set to false, turns off auto replication.
*

          * *type: boolean*

        * **databaseNames**
          * *description: List of database names (can be an empty list if setting up Auto-Replication).*

          * **items**
            * *example: x\_db*

            * *type: string*

          * *type: array*

        * **regionID**
          * *description: Region ID of the secondary region*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: regionID*

        * *1: databaseNames*

      * *type: object*

    * **StorageDRStatus**
      * *description: Represents Storage DR status information*

      * **properties**
        * **compute**
          * *description: Represents information related to a workspace group's latest storage DR operation*

          * **properties**
            * **completedAttachments**
              * *description: The number of database attachments that have been setup*

              * *type: integer*

            * **completedWorkspaces**
              * *description: The number of workspaces that have been setup*

              * *type: integer*

            * **secondaryWorkspaceGroupIDs**
              * *description: The IDs of the secondary (standby) workspace groups in this DR group*

              * **items**
                * *format: uuid*

                * *type: string*

              * *type: array*

            * **storageDRState**
              * *description: Status of Storage DR operation*

              * **enum**
                * *0: Active*

                * *1: Completed*

                * *2: Failed*

                * *3: Expired*

                * *4: Canceled*

              * *type: string*

            * **storageDRType**
              * *description: Name of Storage DR operation*

              * **enum**
                * *0: Failover*

                * *1: Failback*

                * *2: PreProvisionStart*

                * *3: PreProvisionStop*

              * *type: string*

            * **totalAttachments**
              * *description: The total number of database attachments to setup*

              * *type: integer*

            * **totalWorkspaces**
              * *description: The total number of workspaces to setup*

              * *type: integer*

          * **required**
            * *0: storageDRType*

            * *1: storageDRState*

            * *2: totalWorkspaceBuildTasks*

            * *3: totalDatabaseAttachTasks*

            * *4: completedWorkspaceBuildTasks*

            * *5: completedDatabaseAttachTasks*

          * *type: object*

        * **storage**
          * **items**
            * *$ref: #/components/schemas/ReplicatedDatabase*

          * *type: array*

      * **required**
        * *0: compute*

        * *1: storage*

      * *type: object*

    * **TableEgressDrop**
      * *description: Represents the information specified to drop exporting data from a table to Apache Iceberg format*

      * **properties**
        * **egressID**
          * *description: The ID of the export operation*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *type: string*

      * **required**
        * *0: egressID*

      * *type: object*

    * **TableEgressResume**
      * *description: Represents the information specified to resume exporting data from a table to Apache Iceberg format*

      * **properties**
        * **egressID**
          * *description: The ID of the export operation*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *type: string*

      * **required**
        * *0: egressID*

      * *type: object*

    * **TableEgressStart**
      * *description: Represents the information specified to start exporting data from a table to Apache Iceberg format*

      * **properties**
        * **catalogInfo**
          * *description: Catalog information for egressing data*

          * *type: object*

        * **columnNames**
          * **items**
            * *description: The names of the columns to egress*

            * *example: column1*

            * *type: string*

          * *type: array*

        * **databaseName**
          * *description: The name of the database*

          * *example: sample\_db*

          * *type: string*

        * **incremental**
          * *description: Whether the export process is incremental or not*

          * *type: boolean*

        * **partitionSpec**
          * *description: Partition specification of the table*

          * *type: object*

        * **properties**
          * *description: Properties of the table*

          * *type: object*

        * **refreshInterval**
          * *description: The incremental export process refresh internal in seconds*

          * *type: integer*

        * **sortOrderSpec**
          * *description: Sort order specification of the table*

          * *type: object*

        * **storageID**
          * *description: The SingleStore identifier that uniquely identifies the database associated with the export process*

          * *type: string*

        * **storageInfo**
          * *description: Storage information for egressing data*

          * *type: object*

        * **tableName**
          * *description: The name of the table*

          * *example: sample\_table*

          * *type: string*

      * **required**
        * *0: databaseName*

        * *1: tableName*

        * *2: columnNames*

        * *3: storageInfo*

        * *4: catalogInfo*

      * *type: object*

    * **TableEgressStatus**
      * *description: Represents the status of an export operation*

      * **properties**
        * **status**
          * *description: The status of the export operation*

          * *example: Running*

          * *type: string*

        * **statusMsg**
          * *description: The status message of the export operation*

          * *type: string*

      * **required**
        * *0: status*

      * *type: object*

    * **TableEgressStatusParams**
      * *description: Represents the status of exporting data from a table to Apache Iceberg format*

      * **properties**
        * **egressID**
          * *description: The ID of the export operation*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *type: string*

      * **required**
        * *0: egressID*

      * *type: object*

    * **TableEgressSuspend**
      * *description: Represents the information specified to suspend exporting data from a table to Apache Iceberg format*

      * **properties**
        * **egressID**
          * *description: The ID of the export operation*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *type: string*

      * **required**
        * *0: egressID*

      * *type: object*

    * **Team**
      * *description: A SingleStoreDB Cloud team.*

      * **example**
        * *createdAt: 2023-09-18T09:56:56Z*

        * *description: All analysts in the abc.com organization*

        * **memberTeams**
          * **0**
            * *description: *

            * *name: APAC Analysts*

            * *teamID: 3a6fd5c9-616c-4dea-b41c-92eb1d442889*

        * **memberUsers**
          * **0**
            * *email: jane.doe\@abc.com*

            * *firstName: Jane*

            * *lastName: Doe*

            * *userID: 121e74be-6b93-44ac-b240-9be663f680de*

          * **1**
            * *email: jack.smith\@abc.com*

            * *firstName: Jack*

            * *lastName: Smith*

            * *userID: a69181f0-8d64-4b31-a516-ce1b6483edd4*

        * *name: Analysts*

        * *teamID: c74bb6a6-0000-1000-9000-1d874fa277b0*

      * **properties**
        * **createdAt**
          * *description: Team creation timestamp.*

          * *example: 2023-09-18T09:56:56Z*

          * *type: string*

        * **description**
          * *description: Team description.*

          * *example: All analysts in the abc.com organization*

          * *type: string*

        * **memberTeams**
          * **items**
            * *$ref: #/components/schemas/TeamInfo*

          * *type: array*

        * **memberUsers**
          * **items**
            * *$ref: #/components/schemas/UserInfo*

          * *type: array*

        * **name**
          * *description: Team name.*

          * *example: Analysts*

          * *type: string*

        * **teamID**
          * *description: Team identifier.*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: teamID*

        * *1: name*

        * *2: description*

      * *type: object*

    * **TeamCreate**
      * *description: Information specified when creating a team.*

      * **properties**
        * **description**
          * *description: Optional team description.*

          * *example: All analysts in the abc.com organization*

          * *type: string*

        * **name**
          * *description: Team name.*

          * *example: Analysts*

          * *type: string*

      * **required**
        * *0: name*

      * *type: object*

    * **TeamInfo**
      * *description: Summary information about a SingleStoreDB Cloud team.*

      * **properties**
        * **description**
          * *description: Team description.*

          * *example: All analysts in the abc.com organization*

          * *type: string*

        * **name**
          * *description: Team name.*

          * *example: Analysts*

          * *type: string*

        * **teamID**
          * *description: Team identifier.*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: teamID*

        * *1: name*

        * *2: description*

      * *type: object*

    * **TeamUpdate**
      * *description: Information specified when updating a team.*

      * **properties**
        * **addMemberTeamIDs**
          * *description: List of identifiers of teams to be added as members.*

          * **items**
            * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

            * *format: uuid*

            * *type: string*

          * *type: array*

        * **addMemberUserEmails**
          * *description: List of emails of users to be added as members.*

          * **items**
            * *example: jane.doe\@abc.com*

            * *type: string*

          * *type: array*

        * **addMemberUserIDs**
          * *description: List of identifiers of users to be added as members.*

          * **items**
            * *example: 121e74be-6b93-44ac-b240-9be663f680de*

            * *format: uuid*

            * *type: string*

          * *type: array*

        * **description**
          * *description: Team description.*

          * *example: All analysts in the abc.com organization*

          * *type: string*

        * **name**
          * *description: Team name.*

          * *example: Analysts*

          * *type: string*

        * **removeMemberTeamIDs**
          * *description: List of identifiers of teams to be removed from members.*

          * **items**
            * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

            * *format: uuid*

            * *type: string*

          * *type: array*

        * **removeMemberUserEmails**
          * *description: List of emails of users to be removed from members.*

          * **items**
            * *example: jane.doe\@abc.com*

            * *type: string*

          * *type: array*

        * **removeMemberUserIDs**
          * *description: List of identifiers of users to be removed from members.*

          * **items**
            * *example: 121e74be-6b93-44ac-b240-9be663f680de*

            * *format: uuid*

            * *type: string*

          * *type: array*

      * *type: object*

    * **TypedRole**
      * **properties**
        * **resourceType**
          * *description: Resource type of the role*

          * *type: string*

        * **role**
          * *description: The role name*

          * *type: string*

      * **required**
        * *0: role*

        * *1: resourceType*

      * *type: object*

    * **UpdateWindow**
      * *description: Represents information related to an update window*

      * **properties**
        * **day**
          * *description: Day of week (0-6), starting on Sunday*

          * *type: number*

        * **hour**
          * *description: Hour of day - 0 to 23 (UTC)*

          * *type: number*

      * **required**
        * *0: hour*

        * *1: day*

      * *type: object*

    * **User**
      * **allOf**
        * **0**
          * *$ref: #/components/schemas/UserInfo*

        * **1**
          * *description: Information about a SingleStoreDB Cloud user.*

          * **properties**
            * **cloudPrincipal**
              * *description: Customer cloud identity bound to a cloud principal user.*

              * *example: arn:aws:iam::123456789012:role/IngestionRole*

              * *type: string*

            * **createdBy**
              * *description: Identifier of the user that created a service account or cloud principal user.*

              * *format: uuid*

              * *type: string*

            * **description**
              * *description: Description for service account and cloud principal users.*

              * *example: Service account used by ingestion jobs.*

              * *type: string*

            * **userKind**
              * *description: User kind.*

              * **enum**
                * *0: Standard*

                * *1: ServiceAccount*

                * *2: CloudPrincipal*

              * *example: Standard*

              * *type: string*

          * **required**
            * *0: userKind*

          * *type: object*

    * **UserInfo**
      * *description: Summary information about a SingleStoreDB Cloud user.*

      * **properties**
        * **email**
          * *description: The email address of the user.*

          * *example: jane.doe\@abc.com*

          * *type: string*

        * **firstName**
          * *description: First name of the user.*

          * *example: Jane*

          * *type: string*

        * **lastName**
          * *description: Last name of the user.*

          * *example: Doe*

          * *type: string*

        * **userID**
          * *description: User identifier.*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: userID*

        * *1: email*

        * *2: firstName*

        * *3: lastName*

      * *type: object*

    * **UserInvitation**
      * *description: Information specified when creating a user invitation.*

      * **properties**
        * **actedAt**
          * *description: Timestamp of most recent state change.*

          * *format: date-time*

          * *type: string*

        * **createdAt**
          * *description: Creation timestamp.*

          * *format: date-time*

          * *type: string*

        * **email**
          * *description: User email address.*

          * *example: alice\@abc.com*

          * *type: string*

        * **invitationID**
          * *description: Invitation identifier.*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *format: uuid*

          * *type: string*

        * **message**
          * *description: Welcome message*

          * *example: Welcome to SingleStore\@abc.com*

          * *type: string*

        * **state**
          * *description: Invitation state. Pending, Accepted, Refused, or Revoked.*

          * **enum**
            * *0: Pending*

            * *1: Accepted*

            * *2: Refused*

            * *3: Revoked*

          * *example: Pending*

          * *type: string*

        * **teamIDs**
          * *description: List of user teams.*

          * **items**
            * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

            * *format: uuid*

            * *type: string*

          * *type: array*

      * *type: object*

    * **UserInvitationCreate**
      * *description: Information specified when creating a user invitation.*

      * **properties**
        * **email**
          * *description: User email address.*

          * *example: alice\@abc.com*

          * *format: email*

          * *type: string*

        * **teamIDs**
          * *description: List of user teams.*

          * **items**
            * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

            * *format: uuid*

            * *type: string*

          * *type: array*

      * **required**
        * *0: email*

      * *type: object*

    * **Workspace**
      * *description: Represents information related to a workspace*

      * **properties**
        * **autoScale**
          * *$ref: #/components/schemas/AutoScale*

        * **autoSuspend**
          * *description: (If included in the output) Represents the current auto suspend settings enabled for this workspace. If autoSuspend has an empty value, then the auto suspend settings are disabled*

          * **properties**
            * **idleAfterSeconds**
              * *description: (If included in the output) The duration (in seconds) the workspace must be inactive until it automatically suspends*

              * *type: number*

            * **idleChangedAt**
              * *description: (If included in the output) The timestamp when idleAfterSeconds was last changed*

              * *type: string*

            * **scheduledAfterSeconds**
              * *description: (If included in the output) The scheduled duration (in seconds) after which the workspace must be suspended*

              * *type: number*

            * **scheduledChangedAt**
              * *description: (If included in the output) The timestamp when scheduledSuspendAt was last changed*

              * *type: string*

            * **scheduledSuspendAt**
              * *description: (If included in the output) The timestamp when the workspace will be suspended*

              * *type: string*

            * **suspendType**
              * *description: The type of auto suspend currently enabled*

              * **enum**
                * *0: IDLE*

                * *1: SCHEDULED*

              * *type: string*

            * **suspendTypeChangedAt**
              * *description: (If included in the output) The timestamp when suspendType was last changed*

              * *type: string*

          * **required**
            * *0: suspendType*

          * *type: object*

        * **cacheConfig**
          * *description: Specifies the multiplier for the persistent cache associated with the workspace. It can have one of the following values: 1, 2, or 4.
*

          * *type: number*

        * **createdAt**
          * *description: The timestamp of when the workspace was created*

          * *type: string*

        * **deploymentType**
          * *description: Specifies the deployment type for the workspace. It can have one of the following values: \`PRODUCTION\` or \`NON-PRODUCTION\`. If the value wasn't changed on creation, then the default will be \`PRODUCTION\`. If set to \`NON-PRODUCTION\`, the upgrades are only applied to the non-production workspaces.
*

          * **enum**
            * *0: PRODUCTION*

            * *1: NON-PRODUCTION*

          * *type: string*

        * **endpoint**
          * *description: Endpoint to connect to the workspace*

          * *type: string*

        * **kaiEnabled**
          * *description: Specifies if the workspace is kai enabled or not.*

          * *type: boolean*

        * **lastResumedAt**
          * *description: (If included in the output) The timestamp of when the workspace was last resumed*

          * *type: string*

        * **name**
          * *description: Name of the workspace*

          * *type: string*

        * **resumeAttachments**
          * *description: (If included in the output) The result of database attachments after the workspace was resumed*

          * **items**
            * *description: Represents information related to database attachments*

            * **properties**
              * **attachment**
                * *description: The type of attachment*

                * **enum**
                  * *0: READWRITE*

                  * *1: READONLY*

                * *type: string*

              * **database**
                * *description: Name of the database*

                * *type: string*

              * **error**
                * *description: The error if the attachment was not successful*

                * *type: string*

              * **success**
                * *description: Whether the attachment was successful or not*

                * *type: boolean*

            * **required**
              * *0: database*

              * *1: attachment*

              * *2: success*

            * *type: object*

          * *type: array*

        * **scaleFactor**
          * *description: (If included in the output) The scale factor specified for the workspace. The scale factor can be 1, 2 or 4.
*

          * *type: number*

        * **scalingProgress**
          * *description: (If included in the output) The current progress percentage for the scaling workspace*

          * *type: number*

        * **size**
          * *description: Size of the workspace (in workspace size notation), such as "S-00" or "S-1"
*

          * *type: string*

        * **state**
          * *description: State of the workspace*

          * **enum**
            * *0: ACTIVE*

            * *1: PENDING*

            * *2: SUSPENDED*

            * *3: FAILED*

            * *4: TERMINATED*

          * *type: string*

        * **terminatedAt**
          * *description: (If included in the output) The timestamp of when the workspace was terminated*

          * *type: string*

        * **workspaceGroupID**
          * *description: ID of the workspace group containing the workspace*

          * *format: uuid*

          * *type: string*

        * **workspaceID**
          * *description: ID of the workspace*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: name*

        * *1: workspaceID*

        * *2: workspaceGroupID*

        * *3: size*

        * *4: state*

        * *5: createdAt*

      * *type: object*

    * **WorkspaceCreate**
      * *description: Represents the information specified while creating a workspace*

      * **properties**
        * **autoScale**
          * *$ref: #/components/schemas/AutoScale*

        * **autoSuspend**
          * *description: Auto suspend settings for the workspace. If this field is not provided, no settings will be enabled.*

          * **properties**
            * **suspendAfterSeconds**
              * *description: When to suspend the workspace, according to the suspend type chosen*

              * *type: number*

            * **suspendType**
              * *description: The auto suspend mode for the workspace can have the values \`IDLE\`, \`SCHEDULED\`, or \`DISABLED\` (to create the workspace with no auto suspend settings).*

              * **enum**
                * *0: IDLE*

                * *1: SCHEDULED*

                * *2: DISABLED*

              * *example: IDLE*

              * *type: string*

          * *type: object*

        * **cacheConfig**
          * *description: Specifies the multiplier for the persistent cache associated with the workspace. If specified, it enables the cache configuration multiplier. It can have one of the following values: 1, 2, or 4.
*

          * *type: number*

        * **enableKai**
          * *description: Whether to create a SingleStore Kai-enabled workspace*

          * *type: boolean*

        * **name**
          * *description: Name of the workspace*

          * *example: demo-workspace*

          * *type: string*

        * **scaleFactor**
          * *description: Specifies the scale factor for scaling the workspace base size.
            When specified, the compute resources are scaled in proportion to the specified scale factor, while the disk remains unaffected.
            Consequently, the credit consumption is also increased proportionately.
            It can have one of the following values: 1, 2, or 4.
            For more information, refer to \[Workspace Scaling]\(https\://docs.singlestore.com/cloud/getting-started-with-singlestore-helios/about-workspaces/workspace-scaling/).
*

          * *type: number*

        * **size**
          * *description: Size of the workspace (in workspace size notation), such as "S-1". The default value is "S-00".
*

          * *example: S-2*

          * *type: string*

        * **workspaceGroupID**
          * *description: ID of the workspace group in which the workspace is created*

          * *example: c74bb6a6-0000-1000-9000-1d874fa277b0*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: name*

        * *1: workspaceGroupID*

      * *type: object*

    * **WorkspaceGroup**
      * *description: Represents information related to a workspace group*

      * **properties**
        * **allowAllTraffic**
          * *description: Whether or not all traffic is allowed to the workspace group*

          * *type: boolean*

        * **createdAt**
          * *description: The timestamp of when the workspace was created*

          * *type: string*

        * **deploymentType**
          * *description: Deployment type of the workspace group*

          * **enum**
            * *0: PRODUCTION*

            * *1: NON-PRODUCTION*

          * *type: string*

        * **expiresAt**
          * *description: The timestamp of when the workspace group will expire. At expiration, the workspace group is terminated and all the data is lost.*

          * *type: string*

        * **firewallRanges**
          * *description: The list of allowed inbound IP addresses. An empty list indicates that no inbound requests are allowed.*

          * **items**
            * *type: string*

          * *type: array*

        * **highAvailabilityTwoZones**
          * *description: Whether deployment across two Availability Zones is enabled.*

          * *type: boolean*

        * **name**
          * *description: Name of the workspace group*

          * *type: string*

        * **optInPreviewFeature**
          * *description: Whether 'Opt-in to Preview Features & Updates' is enabled*

          * *type: boolean*

        * **outboundAllowList**
          * *description: The account ID which must be allowed for outbound connections. This is only applicable to AWS provider.*

          * *type: string*

        * **projectID**
          * *description: ID of the project to which the workspace group is assigned.*

          * *format: uuid*

          * *type: string*

        * **projectName**
          * *description: Name of the project to which the workspace group is assigned.*

          * *type: string*

        * **provider**
          * *$ref: #/components/schemas/CloudProvider*

        * **regionID**
          * *description: ID of the region*

          * *format: uuid*

          * *type: string*

        * **regionName**
          * *description: The region code name*

          * *type: string*

        * **smartDRStatus**
          * *description: The status of Smart Disaster Recovery (SmartDR) for the workspace group. For more information, refer to \[the documentation]\(https\://docs.singlestore.com/cloud/manage-data/smart-disaster-recovery-dr-smartdr/).*

          * **enum**
            * *0: ACTIVE*

            * *1: STANDBY*

          * *type: string*

        * **state**
          * *description: State of the workspace group*

          * **enum**
            * *0: ACTIVE*

            * *1: PENDING*

            * *2: FAILED*

            * *3: TERMINATED*

          * *type: string*

        * **terminatedAt**
          * *description: (If included in the output) The timestamp of when the workspace group was terminated*

          * *type: string*

        * **updateWindow**
          * *$ref: #/components/schemas/UpdateWindow*

        * **workspaceGroupID**
          * *description: ID of the workspace group*

          * *format: uuid*

          * *type: string*

      * **required**
        * *0: name*

        * *1: state*

        * *2: workspaceGroupID*

        * *3: createdAt*

        * *4: regionID*

        * *5: provider*

        * *6: regionName*

      * *type: object*

    * **WorkspaceGroupCreate**
      * *description: Represents the information specified while creating a workspace group*

      * **properties**
        * **adminPassword**
          * *description: The admin password for the workspace group. The password must contain:

              \* At least 14 characters
              \* At least one uppercase character
              \* At least one lowercase character
              \* At least one numeric character
              \* At least one special character
              \* At most two consecutive sequential characters
              \* At most three consecutive identical characters

            If a password is not specified while creating a workspace group or if an invalid password is provided, a valid password is generated and returned in the response object.
*

          * *example: *

          * *type: string*

        * **allowAllTraffic**
          * *description: If enabled, allows all traffic to the workspace group.*

          * *type: boolean*

        * **deploymentType**
          * *description: The deployment type that will be applied to all the workspaces within the workspace group. The default value is \`PRODUCTION\`*

          * **enum**
            * *0: PRODUCTION*

            * *1: NON-PRODUCTION*

          * *example: PRODUCTION*

          * *type: string*

        * **expiresAt**
          * *description: The timestamp of when the workspace group will expire. If the expiration time is not specified, the workspace group will have no expiration time. At expiration, the workspace group is terminated and all the data is lost. Expiration time can be specified as a timestamp or duration. For example,

              \* "2023-09-02T15:04:05Z07:00"
              \* "2023-09-02T15:04:05-0700"
              \* "2023-09-02T15:04:05"
              \* "2023-09-02"
              \* "3h30m"
*

          * *example: *

          * *type: string*

        * **firewallRanges**
          * *description: A list of allowed CIDR ranges. An empty list indicates that no inbound requests are allowed. Required
*

          * **example**
            * *0: 192.168.0.1/32*

            * *1: 192.168.0.81/12*

          * **items**
            * *type: string*

          * *type: array*

        * **highAvailabilityTwoZones**
          * *description: Enables deployment across two Availability Zones.*

          * *type: boolean*

        * **name**
          * *description: Name of the workspace group*

          * *example: demo-workspace-group*

          * *type: string*

        * **optInPreviewFeature**
          * *description: If enabled, the deployment gets the latest features and updates immediately. Suitable only for \`NON-PRODUCTION\` deployments and cannot be changed after creation.*

          * *type: boolean*

        * **projectID**
          * *description: Assigns the workspace group to a project, which specifies the edition of the workspace group.*

          * *example: 2d7bd375-0000-1000-9000-8a3d5b4922c0*

          * *format: uuid*

          * *type: string*

        * **provider**
          * *$ref: #/components/schemas/CloudProvider*

        * **regionID**
          * *description: ID of the region where the new workspace group is created*

          * *example: 7e7ffd27-0000-1000-9000-e72828a81ac7*

          * *format: uuid*

          * *type: string*

        * **regionName**
          * *description: The region code name*

          * *example: us-west1*

          * *type: string*

        * **updateWindow**
          * *$ref: #/components/schemas/UpdateWindow*

      * **required**
        * *0: name*

        * *1: firewallRanges*

      * *type: object*

    * **WorkspaceGroupUpdate**
      * *description: Represents the information specified while updating a workspace group*

      * **properties**
        * **adminPassword**
          * *description: The admin password for the workspace group. The password must contain:

              \* At least 14 characters
              \* At least one uppercase character
              \* At least one lowercase character
              \* At least one numeric character
              \* At least one special character
              \* At most two consecutive sequential characters
              \* At most three consecutive identical characters
*

          * *example: *

          * *type: string*

        * **allowAllTraffic**
          * *description: Whether to allow all traffic to the workspace group*

          * *type: boolean*

        * **deploymentType**
          * *description: The deployment type that will be applied to all the workspaces within the workspace group*

          * **enum**
            * *0: PRODUCTION*

            * *1: NON-PRODUCTION*

          * *example: PRODUCTION*

          * *type: string*

        * **expiresAt**
          * *description: The timestamp of when the workspace group will expire. If the expiration time is not specified, the workspace group will have no expiration time. At expiration, the workspace group is terminated and all the data is lost. Expiration time can be specified as a timestamp or duration. For example,

              \* "2023-09-02T15:04:05Z07:00"
              \* "2023-09-02T15:04:05-0700"
              \* "2023-09-02T15:04:05"
              \* "2023-09-02"
              \* "3h30m"
*

          * *example: *

          * *type: string*

        * **firewallRanges**
          * *description: A list of allowed CIDR ranges. An empty list indicates that no inbound requests are allowed.*

          * **example**
            * *0: 192.168.0.1/32*

            * *1: 192.168.0.81/12*

          * **items**
            * *type: string*

          * *type: array*

        * **name**
          * *description: Name of the workspace group*

          * *example: new-workspace-group-name*

          * *type: string*

        * **updateWindow**
          * *$ref: #/components/schemas/UpdateWindow*

      * *type: object*

    * **WorkspaceResume**
      * *description: Represents additional information specified when resuming a workspace*

      * **properties**
        * **disableAutoSuspend**
          * *description: Whether to disable auto suspend or keep the existing auto suspend settings. By default, \`disableAutoSuspend\` is set to \`false\`, and the existing auto suspend settings are preserved.*

          * *type: boolean*

      * *type: object*

    * **WorkspaceUpdate**
      * *description: Represents the information specified while updating a workspace*

      * **properties**
        * **autoScale**
          * *$ref: #/components/schemas/AutoScale*

        * **autoSuspend**
          * *description: Specifies the auto suspend mode for the workspace. It can have one of the following values: \`IDLE\`, \`SCHEDULED\`, or \`DISABLED\`.*

          * **properties**
            * **suspendAfterSeconds**
              * *description: The time interval (in seconds) after which the workspace is suspended, depending on the auto suspend mode.*

              * *type: number*

            * **suspendType**
              * *description: The type of auto suspend mode. Set to \`DISABLED\` to disable auto suspend.*

              * **enum**
                * *0: IDLE*

                * *1: SCHEDULED*

                * *2: DISABLED*

              * *example: IDLE*

              * *type: string*

          * *type: object*

        * **cacheConfig**
          * *description: Specifies the multiplier for the persistent cache associated with the workspace. If specified, it enables the cache configuration multiplier. It can have one of the following values: 1, 2, or 4.
*

          * *type: number*

        * **deploymentType**
          * *description: The deployment type that will be applied to all the workspaces within the group*

          * **enum**
            * *0: PRODUCTION*

            * *1: NON-PRODUCTION*

          * *example: PRODUCTION*

          * *type: string*

        * **enableKai**
          * *description: Whether to enable SingleStore Kai in this workspace*

          * **enum**


          * *type: boolean*

        * **scaleFactor**
          * *description: Specifies the scale factor for scaling the workspace base size.
            When specified, the compute resources are scaled in proportion to the specified scale factor, while the disk remains unaffected.
            Consequently, the credit consumption is also increased proportionately.
            It can have one of the following values: 1, 2, or 4.
            For more information, refer to \[Workspace Scaling]\(https\://docs.singlestore.com/cloud/getting-started-with-singlestore-helios/about-workspaces/workspace-scaling/).
*

          * *type: number*

        * **size**
          * *description: Size of the workspace (in workspace size notation), such as "S-1". The default value is "S-00".
*

          * *example: S-2*

          * *type: string*

      * *type: object*

  * **securitySchemes**
    * **ApiKeyAuth**
      * *bearerFormat: API key*

      * *description: For information on authenticating your API requests, refer to \[\`Management\` API Overview]\(https\://docs.singlestore.com/managed-service/en/reference/management-api.html).
*

      * *scheme: bearer*

      * *type: http*

* **info**
  * **contact**
    * *name: SingleStore Support*

    * *url: https\://www\.singlestore.com/support/*

  * *description: The \`Management\` API can be used to create and manage workspaces, workspace groups, private connections, etc. SingleStore recommends reading the \[\`Management\` API Overview]\(https\://docs.singlestore.com/managed-service/en/reference/management-api.html) before getting started with the API reference.

    All the URLs referenced in this API documentation use the \`https\://api.singlestore.com\` service endpoint as their base.
*

  * *title: SingleStore Management API*

  * *version: 1.2.162*

* *openapi: 3.0.0*

* **paths**
  * **/v1/auditLogs**
    * **get**
      * *description: Returns a list of all of the audit log entries for the user organization or audit logs for user redaction*

      * **parameters**
        * **0**
          * *description: The audit log type*

          * *in: query*

          * *name: type*

          * **schema**
            * *type: string*

        * **1**
          * *description: The audit log source*

          * *in: query*

          * *name: source*

          * **schema**
            * *type: string*

        * **2**
          * *description: The start date (inclusive) for the query in RFC3339 format (2019-10-12T07:20:50.52Z)*

          * *in: query*

          * *name: startDate*

          * **schema**
            * *type: string*

        * **3**
          * *description: The end date (inclusive) for the query in RFC3339 format (2019-10-12T07:20:50.52Z)*

          * *in: query*

          * *name: endDate*

          * **schema**
            * *type: string*

        * **4**
          * *description: The maximum number of rows to return*

          * *in: query*

          * *name: limit*

          * **schema**
            * *type: number*

        * **5**
          * *description: The value of the nextToken returned from a previous query. This will guarantee the next results are new since the last query*

          * *in: query*

          * *name: nextToken*

          * **schema**
            * *type: string*

        * **6**
          * *description: A first name to match against*

          * *in: query*

          * *name: firstName*

          * **schema**
            * *type: string*

        * **7**
          * *description: A last name to match against*

          * *in: query*

          * *name: lastName*

          * **schema**
            * *type: string*

        * **8**
          * *description: An email address to match against*

          * *in: query*

          * *name: email*

          * **schema**
            * *format: email*

            * *type: string*

        * **9**
          * *description: A user ID to match against*

          * *in: query*

          * *name: userID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **10**
          * *description: Filter by the API key ID used to perform the action*

          * *in: query*

          * *name: apiKeyID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **11**
          * *description: A workspace group ID to filter by*

          * *in: query*

          * *name: workspaceGroupID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **12**
          * *description: A project ID to filter by*

          * *in: query*

          * *name: projectID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **13**
          * *description: A team ID to filter by*

          * *in: query*

          * *name: teamID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **14**
          * *description: A workspace ID to filter by*

          * *in: query*

          * *name: workspaceID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **15**
          * *description: If true, sort audit logs by createdAt in descending order*

          * *in: query*

          * *name: sortByDescending*

          * **schema**
            * *type: boolean*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **auditLogs**
                    * **items**
                      * *$ref: #/components/schemas/AuditLog*

                    * *type: array*

                  * **nextToken**
                    * *description: The nextToken value can be used in a subsequent query to guarantee any log entries are new since this query*

                    * *type: string*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists all of the audit logs for the user organization or audit logs for user redaction*

      * **tags**
        * *0: AuditLogs*

  * **/v1/billing/usage**
    * *description: The \`usage\` endpoint under billing can report compute and storage usage.*

    * **get**
      * *description: Returns the compute and storage usage of an organization in a specified timeframe. The results can be grouped by hour, day, and month using the \`aggregateType\` parameter. The usage entries in the result set also include information on the resource ID, type, name, and usage.
        Note that the usage periods are rounded to the nearest hour/day/month that includes the requested range.
        For example, if the start time is "2023-07-30T18:30:00Z" and the end time is "2023-07-31T18:30:00Z",
        the hourly usage entries would be returned for the period from "2023-07-30T18:00:00Z" to "2023-07-31T19:00:00Z". Same goes for daily and monthly usage entries.
*

      * **parameters**
        * **0**
          * *description: The metric type. It can have the following values:

              \* \`ComputeCredit\`: Returns the compute usage.
              \* \`StorageAvgByte\`: Returns the average bytes of storage usage.

            By default, usage for both metrics is returned.
*

          * *in: query*

          * *name: metric*

          * **schema**
            * **enum**
              * *0: ComputeCredit*

              * *1: StorageAvgByte*

            * *type: string*

        * **1**
          * *description: The start time for the usage interval in UTC ISO8601 format. For example, "2023-07-30T18:30:00Z".
*

          * *in: query*

          * *name: startTime*

          * **schema**
            * *type: string*

        * **2**
          * *description: The end time for the usage interval in UTC ISO8601 format. For example, "2023-07-30T18:30:00Z".
*

          * *in: query*

          * *name: endTime*

          * **schema**
            * *type: string*

        * **3**
          * *description: The interval used to aggregate the usage. It can have the following values: \`hour\`, \`day\`, and \`month\`. By default, the results are grouped by hour."
*

          * *in: query*

          * *name: aggregateBy*

          * **schema**
            * **enum**
              * *0: hour*

              * *1: day*

              * *2: month*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **billingUsage**
                    * **items**
                      * *$ref: #/components/schemas/BillingUsage*

                    * *type: array*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Returns the compute and storage usage of an organization*

      * **tags**
        * *0: Billing*

  * **/v1/billing/usage/simulate**
    * *description: Allows a user to simulate billing usage given different resource configurations over time.*

    * **post**
      * *description: Simulates billing usage for resources based on provided configurations. This endpoint allows you to estimate compute usage costs by specifying resource configurations and time ranges.
        You must provide a time range (startAt and endBefore). An array of resource configurations may optionally be provided to simulate state changes of resources over time.
        Each resource configuration defines the characteristics of a resource during a specific time period. If no configurations are provided, a simulation will be run using the
        existing resources in the project for the time range based on their current configurations.
*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/SimulateUsageRequest*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/SimulateUsageResponse*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Returns an array of simulated compute usage for the given resource configurations.*

      * **tags**
        * *0: Billing*

  * **/v1/cloudPrincipals**
    * *description: The \`cloudPrincipals\` endpoint is used to manage cloud principals.*

    * **post**
      * *description: Creates a cloud principal in the current organization.

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/CloudPrincipalCreate*

        * *description: Cloud principal creation parameters.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/CloudPrincipal*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **409**
          * *description: Cloud principal already exists in this organization*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a cloud principal in the current organization.*

      * **tags**
        * *0: Cloud Principals*

  * **/v1/cloudPrincipals/{cloudPrincipalID}**
    * **delete**
      * *description: Deletes the specified cloud principal from the current organization.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/cloudPrincipalID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/CloudPrincipalIDResponse*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A cloud principal with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a cloud principal.*

      * **tags**
        * *0: Cloud Principals*

    * **patch**
      * *description: Updates the name and/or description for the specified cloud principal.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/cloudPrincipalID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/CloudPrincipalUpdate*

        * *description: Cloud principal update parameters.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/CloudPrincipal*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A cloud principal with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Updates a cloud principal.*

      * **tags**
        * *0: Cloud Principals*

  * **/v1/cloudfunctions**
    * **get**
      * *description: Lists all the cloud functions in the current organization.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/limit*

        * **1**
          * *$ref: #/components/parameters/offsetID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **cloudFunctions**
                    * **items**
                      * *$ref: #/components/schemas/NotebookCloudFunction*

                    * *type: array*

                  * **metadata**
                    * *$ref: #/components/schemas/NotebookCloudFunctionPaginationMetadata*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Bad request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Lists the cloud functions*

      * **tags**
        * *0: CloudFunctions*

    * **post**
      * *description: Creates a new cloud function. Upon successful completion of the request, the ID of the cloud function is returned in the API response.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/CloudFunctionCreate*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **cloudFunctionID**
                    * *example: 7b68b78d-a000-4000-9000-0864fd331524*

                    * *type: string*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Bad request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new cloud function*

      * **tags**
        * *0: CloudFunctions*

  * **/v1/cloudfunctions/{cloudfunctionID}**
    * **delete**
      * *description: Deletes the cloud function with the specified ID. You must specify the ID of the cloud function in the API call.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/cloudfunctionID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/NotebookCloudFunction*

          * *description: OK*

        * **400**
          * *description: Bad request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not found*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a cloud function*

      * **tags**
        * *0: CloudFunctions*

    * **get**
      * *description: Returns information on the cloud function with the specified ID. You must specify the cloud function ID in the API call.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/cloudfunctionID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/NotebookCloudFunction*

          * *description: OK*

        * **400**
          * *description: Bad request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not found*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a cloud function*

      * **tags**
        * *0: CloudFunctions*

    * **patch**
      * *description: Updates the cloud function with the specified ID. You must specify the cloud function ID in the API call.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/cloudfunctionID*

        * **1**
          * *$ref: #/components/parameters/lastKnownUpdatedAt*

        * **2**
          * *$ref: #/components/parameters/updateNotebookSnapshot*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/CloudFunctionUpdate*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/NotebookCloudFunction*

          * *description: OK*

        * **400**
          * *description: Bad request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not found*

        * **409**
          * *description: Conflict error*

        * **500**
          * *description: Internal server error*

      * *summary: Updates a cloud function*

      * **tags**
        * *0: CloudFunctions*

  * **/v1/cloudfunctions/{cloudfunctionID}/token**
    * **get**
      * *description: Returns a token that can be used to interact with cloud function applications.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/cloudfunctionID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/AppToken*

          * *description: OK*

        * **400**
          * *description: Bad request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Gets a cloud function token*

      * **tags**
        * *0: CloudFunctions*

  * **/v1/files/fs/{location}**
    * **get**
      * *description: Returns a list of all files from personal, shared or models space.

        You must specify the \`location\`.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *description: Location of the files*

          * *in: path*

          * *name: location*

          * **schema**
            * *$ref: #/components/schemas/FileLocationSchema*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/FileObjectMetadata*

          * *description: OK*

        * **307**
          * *description: Temporary Redirect*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not Found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists all files from personal, shared or models space.*

      * **tags**
        * *0: Files*

  * **/v1/files/fs/{location}/{path}**
    * **delete**
      * *description: Deletes the file at the specified path in personal, shared or models space.

        You must specify the \`location\` and file \`path\` in the API call.
*

      * **parameters**
        * **0**
          * *description: Location of the files*

          * *in: path*

          * *name: location*

          * **schema**
            * *$ref: #/components/schemas/FileLocationSchema*

        * **1**
          * *description: Path in personal, shared or models space to a file to delete*

          * *example: filename.ipynb*

          * *in: path*

          * *name: path*

          * **schema**
            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **name**
                    * *description: filename.ipynb*

                    * *type: string*

                  * **path**
                    * *description: /*

                    * *type: string*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not Found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a file from personal, shared or models space.*

      * **tags**
        * *0: Files*

    * **get**
      * *description: Returns the information about a file or redirects to the file download URL.

        You must specify the \`location\` and the file \`path\` in the API call.
*

      * **parameters**
        * **0**
          * *description: Location of the files*

          * *in: path*

          * *name: location*

          * **schema**
            * *$ref: #/components/schemas/FileLocationSchema*

        * **1**
          * *description: Path in personal, shared or models space to a file*

          * *example: filename.ipynb*

          * *in: path*

          * *name: path*

          * **schema**
            * *type: string*

        * **2**
          * *description: If enabled, the API request returns only metadata for the specified file instead of downloading it.*

          * *in: query*

          * *name: metadata*

          * **schema**
            * *type: boolean*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/FileObjectMetadata*

          * *description: OK*

        * **307**
          * *description: Temporary Redirect*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not Found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a file or downloads a file from personal, shared or models space.*

      * **tags**
        * *0: Files*

    * **patch**
      * *description: Modifies the path of the existing file in personal, shared or models space to the new path specified in the request body.

        You must specify the \`location\` and file \`path\` in the API call.
*

      * **parameters**
        * **0**
          * *description: Location of the files*

          * *in: path*

          * *name: location*

          * **schema**
            * *$ref: #/components/schemas/FileLocationSchema*

        * **1**
          * *description: Path in personal, shared or models space to modify*

          * *example: filename.ipynb*

          * *in: path*

          * *name: path*

          * **schema**
            * *type: string*

      * **requestBody**
        * **content**
          * **application/json**
            * **example**
              * *newPath: new\_filename.ipynb*

            * **schema**
              * **properties**
                * **newPath**
                  * *description: New path of the file*

                  * *type: string*

              * *type: object*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **name**
                    * *description: filename.ipynb*

                    * *type: string*

                  * **path**
                    * *description: /*

                    * *type: string*

                * *type: object*

          * *description: OK*

        * **307**
          * *description: Temporary Redirect*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not Found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Modifies a file in personal, shared or models space.*

      * **tags**
        * *0: Files*

    * **put**
      * *description: This endpoint allows you to create or upload a new file at a specified path within personal, shared or models space. The behavior depends on the contents of the request body and the format of the path:
         \- \*\*File Upload:\*\* If the request body contains a file, the file is uploaded to the specified path within personal, shared or models space.

        You must specify the \`location\` and the file \`path\` in the API call.
*

      * **parameters**
        * **0**
          * *description: Location of the files*

          * *in: path*

          * *name: location*

          * **schema**
            * *$ref: #/components/schemas/FileLocationSchema*

        * **1**
          * *description: Path in personal, shared or models space*

          * *example: filename.ipynb*

          * *in: path*

          * *name: path*

          * **schema**
            * *type: string*

      * **requestBody**
        * **content**
          * **multipart/form-data**
            * **schema**
              * **properties**
                * **file**
                  * *description: File to upload*

                  * *format: binary*

                  * *type: string*

              * **required**
                * *0: file*

              * *type: object*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **name**
                    * *example: filename.ipynb*

                    * *type: string*

                  * **path**
                    * *example: /*

                    * *type: string*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new file or uploads a file to personal, shared or models space.*

      * **tags**
        * *0: Files*

  * **/v1/flow**
    * *description: Manages SingleStore Flow instances*

    * **get**
      * *description: Returns a list of all of the SingleStore Flow instances accessible to the user. Use the \`includeTerminated\` parameter to get a list of terminated Flow instances.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *description: To include any terminated Flow instances, set to \`true\`*

          * *in: query*

          * *name: includeTerminated*

          * **schema**
            * *type: boolean*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * **0**
                  * *createdAt: 2026-01-18T09:56:56Z*

                  * *flowID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

                  * *name: flow-instance-1*

                  * *workspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785c*

              * **schema**
                * **items**
                  * *$ref: #/components/schemas/Flow*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists the Flow instances the user can access*

      * **tags**
        * *0: Flow*

    * **post**
      * *description: Creates a new SingleStore Flow instance for the current user.

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/FlowCreate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *flowID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **flowID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: flowID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new Flow instance*

      * **tags**
        * *0: Flow*

  * **/v1/flow/{flowID}**
    * **delete**
      * *description: Terminates a SingleStore Flow instance with the specified ID. You must specify the Flow instance ID in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/flowID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *flowID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **flowID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: flowID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A Flow instance with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Terminates a Flow instance*

      * **tags**
        * *0: Flow*

    * **get**
      * *description: Returns information about the SingleStore Flow instance with the specified ID, in JSON format. You must specify the Flow instance ID in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/flowID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *createdAt: 2026-01-18T09:56:56Z*

                * *flowID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

                * *name: flow-instance-1*

                * *workspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785c*

              * **schema**
                * *$ref: #/components/schemas/Flow*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A Flow instance with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a Flow instance*

      * **tags**
        * *0: Flow*

  * **/v1/invitations**
    * **get**
      * *description: Returns a list of open invitations for the current organization.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *description: Show only invitations with emails matching this value or regular expression.*

          * *in: query*

          * *name: email*

          * **schema**
            * *type: string*

        * **1**
          * *description: Show only invitations with state matching this value.*

          * *in: query*

          * *name: state*

          * **schema**
            * *type: string*

        * **2**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/UserInvitation*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists open invitations for the current organization.*

      * **tags**
        * *0: Invitations*

    * **post**
      * *description: Creates and sends an invitation to join the organization to an email address.

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/UserInvitationCreate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/UserInvitation*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **409**
          * *description: User is already a member*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Invites a user to the current organization*

      * **tags**
        * *0: Invitations*

  * **/v1/invitations/{invitationID}**
    * **delete**
      * *description: Revokes the specified invitation.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/invitationID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *invitationID: 03891d70-ea86-403e-8463-113917fd0466*

              * **schema**
                * **properties**
                  * **invitationID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: invitationID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A invitation with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Revokes an invitation*

      * **tags**
        * *0: Invitations*

    * **get**
      * *description: Returns information for the specified invitation.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/invitationID*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *createdAt: 2023-09-18T09:56:56Z*

                * *email: alice\@abc.com*

                * *invitationID: c74bb6a6-0000-1000-9000-1d874fa277b1*

                * *message: Welcome to SingleStore\@abc.com*

                * *state: Pending*

              * **schema**
                * *$ref: #/components/schemas/UserInvitation*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: An invitation with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about an invitation.*

      * **tags**
        * *0: Invitations*

  * **/v1/jobs**
    * **post**
      * *description: This creates a job. A job sets a scheduled execution of a notebook and can cause notebooks to be run on a schedule or one-time only

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/JobCreate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/Job*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new job*

      * **tags**
        * *0: Jobs*

  * **/v1/jobs/{jobID}**
    * **delete**
      * *description: This deletes a job and all execution snapshots associated with a job.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/jobID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *type: boolean*

          * *description: OK*

        * **400**
          * *description: Bad request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a job*

      * **tags**
        * *0: Jobs*

    * **get**
      * *description: Returns the metadata on target, schedule and notebook for a job specified by a jobid.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/jobID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/Job*

          * *description: OK*

        * **400**
          * *description: Bad request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about the specified job*

      * **tags**
        * *0: Jobs*

  * **/v1/jobs/{jobID}/executions**
    * **get**
      * *description: Returns the information of the executions of a specified job. Specify which executions you want with the parameters.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/jobID*

        * **1**
          * *description: Start execution number.*

          * *in: query*

          * *name: start*

          * **schema**
            * *type: number*

        * **2**
          * *description: End execution number.*

          * *in: query*

          * *name: end*

          * **schema**
            * *type: number*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/ExecutionsResult*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Get executions for a job*

      * **tags**
        * *0: Jobs*

  * **/v1/jobs/{jobID}/parameters**
    * **get**
      * *description: Returns the array of the parameters of a specified job.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/jobID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/JobParameter*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Get parameters for a job*

      * **tags**
        * *0: Jobs*

  * **/v1/jobs/runtimes**
    * **get**
      * *description: Returns the list of available runtimes for jobs.

        This route is currently not supported by BYOC.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/RuntimesResult*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Bad request*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Get the list of available job runtimes*

      * **tags**
        * *0: Jobs*

  * **/v1/organizations/{organizationID}/accessControls**
    * **get**
      * *description: Return all the roles on the resource type, which include all grants of the given resource*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/organizationID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/ResourceRole*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Get RBAC access information about the organization*

      * **tags**
        * *0: Organizations*

    * **patch**
      * *description: Grant or revoke grants on roles of the resource*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/organizationID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/ControlAccessAction*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Update the RBAC grants on the organization*

      * **tags**
        * *0: Organizations*

  * **/v1/organizations/current**
    * **get**
      * *description: Returns information about the current authorized user's organization.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/Organization*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about the current organization*

      * **tags**
        * *0: Organizations*

  * **/v1/privateConnections**
    * *description: The \`privateConnections\` endpoint can be used to create and manage private connections to SingleStoreDB Cloud workspaces.*

    * **post**
      * *description: Creates a new private connection. Upon successful completion of the request, a private connection is scheduled for creation. To query the private connection status, use the endpoints for the workspace group and workspace (if provided).
*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/PrivateConnectionCreate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *privateConnectionID: b07fff9f-0000-1000-9000-b1974e06b736*

              * **schema**
                * **properties**
                  * **privateConnectionID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: privateConnectionID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new private connection*

      * **tags**
        * *0: Private Connections*

  * **/v1/privateConnections/{connectionID}**
    * **delete**
      * *description: Deletes a private connection for the specified connection ID. Upon successful completion, a private connection is scheduled for deletion.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/connectionID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *privateConnectionID: b07fff9f-0000-1000-9000-b1974e06b736*

              * **schema**
                * **properties**
                  * **privateConnectionID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: privateConnectionID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A private connection with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a private connection*

      * **tags**
        * *0: Private Connections*

    * **get**
      * *description: Returns private connection information for the specified connection ID, in JSON format. You must specify the connection ID in the API call.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/connectionID*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/PrivateConnection*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A private connection with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a private connection*

      * **tags**
        * *0: Private Connections*

    * **patch**
      * *description: Updates a private connection. You must specify the connection ID in the API call.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/connectionID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/PrivateConnectionUpdate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *privateConnectionID: b07fff9f-0000-1000-9000-b1974e06b736*

              * **schema**
                * **properties**
                  * **privateConnectionID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: privateConnectionID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A private connection with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Updates a private connection*

      * **tags**
        * *0: Private Connections*

  * **/v1/projects**
    * *description: The projects endpoint can be used to manage projects.*

    * **get**
      * *description: Returns a list of all of the projects accessible to the user.

        This route is currently not supported by BYOC.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * **0**
                  * *createdAt: 2025-10-24T09:56:56Z*

                  * *edition: STANDARD*

                  * *name: demo-project*

                  * *projectID: 70ab4e59-0000-1000-9000-76a5b06ed9e3*

              * **schema**
                * **items**
                  * *$ref: #/components/schemas/Project*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists the projects the user can access*

      * **tags**
        * *0: Projects*

    * **post**
      * *description: Creates a new project for the current user.

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/ProjectCreate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *projectID: 70ab4e59-0000-1000-9000-76a5b06ed9e3*

              * **schema**
                * *$ref: #/components/schemas/ProjectIDResponse*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new project*

      * **tags**
        * *0: Projects*

  * **/v1/projects/{projectID}**
    * **delete**
      * *description: Deletes a project with the specified project ID.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/projectID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *projectID: 70ab4e59-0000-1000-9000-76a5b06ed9e3*

              * **schema**
                * *$ref: #/components/schemas/ProjectIDResponse*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A project with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a project*

      * **tags**
        * *0: Projects*

    * **get**
      * *description: Returns information for the specified project ID in JSON format.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/projectID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *createdAt: 2025-10-24T09:56:56Z*

                * *edition: STANDARD*

                * *name: demo-project*

                * *projectID: 70ab4e59-0000-1000-9000-76a5b06ed9e3*

              * **schema**
                * *$ref: #/components/schemas/Project*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A project with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a project*

      * **tags**
        * *0: Projects*

    * **patch**
      * *description: Updates the specified project. You can only update its name.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/projectID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/ProjectUpdate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *projectID: 70ab4e59-0000-1000-9000-76a5b06ed9e3*

              * **schema**
                * *$ref: #/components/schemas/ProjectIDResponse*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A project with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Updates a project*

      * **tags**
        * *0: Projects*

  * **/v1/regions**
    * **get**
      * *description: \*\*Note\*\*: This endpoint is deprecated. Use \`/v2/regions\` instead. 

        Returns a list of valid regions for the user that support workspaces, including the region ID and provider for each region.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * **0**
                  * *provider: GCP*

                  * *region: US West 1 (Oregon)*

                  * *regionID: 1c1de314-0000-1000-9000-5047ff90842e*

                * **1**
                  * *provider: AWS*

                  * *region: Europe Central 1 (Frankfurt)*

                  * *regionID: 7e7ffd27-0000-1000-9000-e72828a81ac7*

                * **2**
                  * *provider: AWS*

                  * *region: Asia Pacific Southeast 2 (Sydney)*

                  * *regionID: c74bb6a6-0000-1000-9000-1d874fa277b7*

              * **schema**
                * **items**
                  * *$ref: #/components/schemas/Region*

                * *type: array*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists all of the regions for the user that support workspaces*

      * **tags**
        * *0: Regions*

  * **/v1/regions/sharedtier**
    * **get**
      * *description: Returns a list of valid regions that support Shared Edition deployments (starter workspaces) for the user, including the region code and provider for each region.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * **0**
                  * *provider: GCP*

                  * *region: US West 1 (Oregon)*

                  * *regionName: us-west1*

                * **1**
                  * *provider: AWS*

                  * *region: Europe Central 1 (Frankfurt)*

                  * *regionName: eu-central-1*

                * **2**
                  * *provider: AWS*

                  * *region: Asia Pacific Southeast 2 (Sydney)*

                  * *regionName: ap-southeast-2*

              * **schema**
                * **items**
                  * *$ref: #/components/schemas/RegionV2*

                * *type: array*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists all the regions that support Shared Edition deployments (starter workspaces) for the user*

      * **tags**
        * *0: Regions*

  * **/v1/roles/{resourceType}**
    * **get**
      * *description: 

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/resourceType*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/RoleDefinition*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists all roles for the given resource type, including custom roles*

      * **tags**
        * *0: Roles*

    * **post**
      * *description: 

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/resourceType*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/RoleCreate*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/RoleDefinition*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new role for the given resource type*

      * **tags**
        * *0: Roles*

  * **/v1/roles/{resourceType}/{role}**
    * **delete**
      * *description: Deletes the specified role.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/resourceType*

        * **1**
          * *$ref: #/components/parameters/role*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *type: boolean*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Resource not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a role.*

      * **tags**
        * *0: Roles*

    * **get**
      * *description: 

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/resourceType*

        * **1**
          * *$ref: #/components/parameters/role*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/RoleDefinition*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets a given role from a given resource type*

      * **tags**
        * *0: Roles*

    * **put**
      * *description: 

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/resourceType*

        * **1**
          * *$ref: #/components/parameters/role*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/RoleUpdate*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/RoleDefinition*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Resource not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Update the name, permission, resource type, and inherits for the custom role.*

      * **tags**
        * *0: Roles*

  * **/v1/secrets**
    * *description: The \`secrets\` endpoint can be used to create and manage secrets.*

    * **get**
      * *description: Returns a list of all of the secrets accessible to the user.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *description: Name of the secret.*

          * *in: query*

          * *name: name*

          * **schema**
            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/Secret*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists the secrets the user can access.*

      * **tags**
        * *0: Secrets*

    * **post**
      * *description: Creates a new secret, which can be used to store sensitive information such as passwords, API keys, and other credentials. You must specify a name and value for the secret in the API request body.

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/SecretCreate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/Secret*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **409**
          * *description: Secret with specified name already exists*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new secret*

      * **tags**
        * *0: Secrets*

  * **/v1/secrets/{secretID}**
    * **delete**
      * *description: Deletes a secret with the specified ID. You must specify the secret ID in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/secretID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *secretID: 03891d70-0000-1000-9000-113917fd0355*

              * **schema**
                * **properties**
                  * **secretID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: secretID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A secret with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a secret*

      * **tags**
        * *0: Secrets*

    * **get**
      * *description: Returns information for the specified secret ID, in JSON format. You must specify the secret ID in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/secretID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/Secret*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A secret with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a secret*

      * **tags**
        * *0: Secrets*

    * **patch**
      * *description: Updates the name or value for the specified secret ID. You must specify the secret ID in the API call and at least one parameter (name or value) in the request body.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/secretID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/SecretUpdate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/Secret*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A secret with the specified ID was not found*

        * **409**
          * *description: Secret with specified name already exists*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Updates the name or value of a secret*

      * **tags**
        * *0: Secrets*

  * **/v1/secrets/{secretID}/accessControls**
    * **get**
      * *description: Return all the roles on the resource type, which include all grants of the given resource*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/secretID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/ResourceRole*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Get RBAC access information about the secret*

      * **tags**
        * *0: Secrets*

    * **patch**
      * *description: Grant or revoke grants on roles of the resource*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/secretID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/ControlAccessAction*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Update the RBAC grants on the secret*

      * **tags**
        * *0: Secrets*

  * **/v1/serviceAccounts**
    * *description: The \`serviceAccounts\` endpoint is used to manage service accounts.*

    * **post**
      * *description: Creates a service account in the current organization.

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/ServiceAccountCreate*

        * *description: Service account creation parameters.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/ServiceAccount*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **409**
          * *description: Service account with the specified name already exists*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a service account in the current organization.*

      * **tags**
        * *0: Service Accounts*

  * **/v1/serviceAccounts/{serviceAccountID}**
    * **delete**
      * *description: Deletes the specified service account from the current organization.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/serviceAccountID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/ServiceAccountIDResponse*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A service account with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a service account.*

      * **tags**
        * *0: Service Accounts*

    * **patch**
      * *description: Updates the name and/or description for the specified service account.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/serviceAccountID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/ServiceAccountUpdate*

        * *description: Service account update parameters.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/ServiceAccount*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A service account with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Updates a service account.*

      * **tags**
        * *0: Service Accounts*

  * **/v1/sharedtier/virtualWorkspaces**
    * **get**
      * *description: Returns a list of all Shared Edition deployments (starter workspaces) for the current user.

        This route is currently not supported by BYOC.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/SharedTierVirtualWorkspace*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: List all Shared Edition deployments (starter workspaces)*

      * **tags**
        * *0: SharedTier*

    * **post**
      * *description: Creates a new Shared Edition deployment (starter workspace) for the current user. You must specify a name, region ID, and firewall range(s) for the starter workspace in the API request body.

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/SharedTierCreateVirtualWorkspace*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *virtualWorkspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **virtualWorkspaceID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: virtualWorkspaceID*

                * *type: object*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new Shared Edition deployment (starter workspace)*

      * **tags**
        * *0: SharedTier*

  * **/v1/sharedtier/virtualWorkspaces/{virtualWorkspaceID}**
    * **delete**
      * *description: Deletes a Shared Edition deployment (starter workspace) for the specified ID. You must specify the ID of the starter workspace in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualWorkspaceID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *type: boolean*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a Shared Edition deployment (starter workspace)*

      * **tags**
        * *0: SharedTier*

    * **get**
      * *description: Returns information about a Shared Edition deployment (starter workspace) with the specified ID. You must specify the ID of the starter workspace in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualWorkspaceID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/SharedTierVirtualWorkspace*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not found*

        * **500**
          * *description: Internal server error*

      * *summary: Returns information about a Shared Edition deployment (starter workspace)*

      * **tags**
        * *0: SharedTier*

  * **/v1/sharedtier/virtualWorkspaces/{virtualWorkspaceID}/users**
    * **post**
      * *description: Creates a new user in a Shared Edition deployment (starter workspace) with the specified ID. You must specify the ID of the starter workspace in the API call. You can specify a password for the user in the request body. If a password is not specified, a password is automatically generated and returned in the API response.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualWorkspaceID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/SharedTierCreateUser*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **example**
                  * *password: Auto-generated-password1!*

                  * *userID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

                * **properties**
                  * **password**
                    * *type: string*

                  * **userID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: userID*

                  * *1: password*

                * *type: object*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new user in a Shared Edition deployment (starter workspace)*

      * **tags**
        * *0: SharedTier*

  * **/v1/sharedtier/virtualWorkspaces/{virtualWorkspaceID}/users/{userID}**
    * **delete**
      * *description: Deletes a user with the specified user ID from a Shared Edition deployment (starter workspace). You must specify the ID of the starter workspace and the user in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualWorkspaceID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **1**
          * *in: path*

          * *name: userID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *type: boolean*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a user from a Shared Edition deployment (starter workspace)*

      * **tags**
        * *0: SharedTier*

    * **patch**
      * *description: Updates a user in a Shared Edition deployment (starter workspace) with the specified user ID. You must specify the ID of the starter workspace and the user in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualWorkspaceID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **1**
          * *in: path*

          * *name: userID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/SharedTierUpdateUser*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *type: boolean*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Updates a user in a Shared Edition deployment (starter workspace)*

      * **tags**
        * *0: SharedTier*

  * **/v1/stage/{deploymentID}/fs**
    * **get**
      * *description: Returns a list of all files and folders located in the Stage's root folder of the specified deployment (either a workspace group or starter workspace).

        You must specify the \`deploymentID\`.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *description: ID of the deployment*

          * *example: 68af2f46-0000-1000-9000-3f6f5365d878*

          * *in: path*

          * *name: deploymentID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/FileObjectMetadata*

          * *description: OK*

        * **307**
          * *description: Temporary Redirect*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not Found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists files and folders in the root folder.*

      * **tags**
        * *0: Stage*

  * **/v1/stage/{deploymentID}/fs/{path}**
    * **delete**
      * *description: Deletes the file or folder at the specified path in a Stage.

        This endpoint supports both URL-encoded and regular URL paths. Here are some examples of valid requests:

        \- Delete a folder:
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder/sample\_folder/
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder%2Fsample\_folder%2F

        \- Delete a file:
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder/sample\_file.txt
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder%2Fsample\_file.txt

        You must specify the \`deploymentID\` and the folder/file path in the API call.

        \## Note: To delete a folder, ensure that the path includes a trailing slash.
*

      * **parameters**
        * **0**
          * *description: ID of the deployment*

          * *example: 68af2f46-0000-1000-9000-3f6f5365d878*

          * *in: path*

          * *name: deploymentID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **1**
          * *description: Path in the Stage to a file or folder to delete*

          * **examples**
            * **file**
              * *value: parent\_folder/sample\_folder/file.json*

            * **folder**
              * *value: parent\_folder/sample\_folder/*

          * *in: path*

          * *name: path*

          * **schema**
            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **name**
                    * *description: sample\_file.txt*

                    * *type: string*

                  * **path**
                    * *description: parent\_folder/sample\_file.txt*

                    * *type: string*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not Found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a file or folder*

      * **tags**
        * *0: Stage*

    * **get**
      * *description: If the specified path is a folder, the API returns the list of files and folders inside this folder in the Stage. If the specified path is a file, the API call is redirected to a download URL.

        This endpoint supports both URL-encoded and regular URL paths. Here are some examples of valid requests:

        \- Get a folder:
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder/sample\_folder/
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder%2Fsample\_folder%2F

        \- Get a file:
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder/sample\_file.txt
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder%2Fsample\_file.txt

        You must specify the \`deploymentID\` and the folder/file path in the API call.

        \## Note: To Get a folder, ensure that the path includes a trailing slash.
*

      * **parameters**
        * **0**
          * *description: ID of the deployment*

          * *example: 68af2f46-0000-1000-9000-3f6f5365d878*

          * *in: path*

          * *name: deploymentID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **1**
          * *description: Path in the Stage to a file or folder*

          * **examples**
            * **file**
              * *value: parent\_folder/sample\_folder/filename.json*

            * **folder**
              * *value: parent\_folder/sample\_folder/*

          * *in: path*

          * *name: path*

          * **schema**
            * *type: string*

        * **2**
          * *description: If enabled, the API request returns only metadata for the specified file instead of downloading it. This parameter is ignored if the specified path is a folder.*

          * *in: query*

          * *name: metadata*

          * **schema**
            * *type: boolean*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/FileObjectMetadata*

          * *description: OK*

        * **307**
          * *description: Temporary Redirect*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not Found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a folder or downloads a file*

      * **tags**
        * *0: Stage*

    * **patch**
      * *description: Modifies the path of the existing file or folder in a Stage to the new path specified in the request body.

        This endpoint supports both URL-encoded and regular URL paths, so both of the following examples are valid requests:

        \- Modify a folder:
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder/sample\_folder/
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder%2Fsample\_folder%2F

        \- Modify a file:
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder/sample\_file.txt
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder%2Fsample\_file.txt

        You must specify the \`deploymentID\` and the folder/file path in the API call.

        \## Note: To modify the path of a folder, ensure that it includes a trailing slash.
*

      * **parameters**
        * **0**
          * *description: ID of the deployment*

          * *example: 68af2f46-0000-1000-9000-3f6f5365d878*

          * *in: path*

          * *name: deploymentID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **1**
          * *description: Path in the Stage to modify*

          * **examples**
            * **file**
              * *value: parent\_folder/sample\_folder/file.json*

            * **folder**
              * *value: parent\_folder/sample\_folder/*

          * *in: path*

          * *name: path*

          * **schema**
            * *type: string*

      * **requestBody**
        * **content**
          * **application/json**
            * **examples**
              * **file**
                * **value**
                  * *newPath: parent\_folder/sample\_folder/file.json*

              * **folder**
                * **value**
                  * *newPath: parent\_folder/sample\_folder/*

            * **schema**
              * **properties**
                * **newPath**
                  * *description: New path of the file or folder*

                  * *type: string*

              * *type: object*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **name**
                    * *description: sample\_file.txt*

                    * *type: string*

                  * **path**
                    * *description: parent\_folder/sample\_file.txt*

                    * *type: string*

                * *type: object*

          * *description: OK*

        * **307**
          * *description: Temporary Redirect*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not Found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Modifies a file or folder in a Stage*

      * **tags**
        * *0: Stage*

    * **put**
      * *description: This endpoint allows you to create a new folder or upload a new file at a specified path within Stage. The behavior depends on the contents of the request body and the format of the path:
         \- \*\*File Upload:\*\* If the request body contains a file, the file is uploaded to the specified path within the Stage.
         \- \*\*Folder Creation:\*\* If the request body does not contain a file and the path ends with a trailing slash (\`/\`), a new folder is created at the specified path.
         \- \*\*Empty File Creation:\*\* If the request body does not contain a file and the path does not end with a trailing slash, an empty file is created at the specified path.

        \*\*Please ensure that the path is correctly formatted according to the desired action. Misformatted paths may lead to unexpected behavior.\*\*

        This endpoint supports both URL-encoded and regular URL paths. Here are some examples of valid requests:

        \- Create a folder:
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder/sample\_folder/
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder%2Fsample\_folder%2F

        \- Upload a file:
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder/sample\_folder/file.json
          \- /v1/stage/68af2f46-0000-1000-9000-3f6f5365d878/fs/parent\_folder%2Fsample\_folder%2Ffile.json

        You must specify the \`deploymentID\` and the folder/file path in the API call.
*

      * **parameters**
        * **0**
          * *description: ID of the deployment*

          * *example: 68af2f46-0000-1000-9000-3f6f5365d878*

          * *in: path*

          * *name: deploymentID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **1**
          * *description: Path in the Stage*

          * **examples**
            * **file**
              * *value: parent\_folder/sample\_folder/file.json*

            * **folder**
              * *value: parent\_folder/sample\_folder/*

          * *in: path*

          * *name: path*

          * **schema**
            * *type: string*

      * **requestBody**
        * **content**
          * **multipart/form-data**
            * **schema**
              * **properties**
                * **file**
                  * *description: File to upload*

                  * *format: binary*

                  * *type: string*

              * *type: object*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **properties**
                  * **name**
                    * *example: file.json*

                    * *type: string*

                  * **path**
                    * *example: /parent\_folder/sample\_folder*

                    * *type: string*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new folder or uploads a file*

      * **tags**
        * *0: Stage*

  * **/v1/teams**
    * *description: The \`teams\` endpoint is used to manage teams.*

    * **get**
      * *description: Returns a list of teams in the current organization.
*

      * **parameters**
        * **0**
          * *description: Show only teams with names matching this value or regular expression.*

          * *in: query*

          * *name: name*

          * **schema**
            * *type: string*

        * **1**
          * *description: Show only teams with descriptions matching this value or regular expression.*

          * *in: query*

          * *name: description*

          * **schema**
            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/Team*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists the teams defined for the current organization. Teams may be filtered by name or description. An empty list is returned if no teams match the filter.*

      * **tags**
        * *0: Teams*

    * **post**
      * *description: Creates a new team. You must specify a name in the API request body.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/TeamCreate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/Team*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **409**
          * *description: Team with specified name already exists*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new team*

      * **tags**
        * *0: Teams*

  * **/v1/teams/{teamID}**
    * **delete**
      * *description: Deletes the specified team.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/teamID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *teamID: 03891d70-ea86-403e-8463-113917fd0355*

              * **schema**
                * **properties**
                  * **teamID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: teamID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A team with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a team*

      * **tags**
        * *0: Teams*

    * **get**
      * *description: Returns information for the specified team.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/teamID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *createdAt: 2023-09-18T09:56:56Z"*

                * *description: All analysts in the abc.com organization*

                * *name: Analysts*

                * *teamID: c74bb6a6-0000-1000-9000-1d874fa277b0*

              * **schema**
                * *$ref: #/components/schemas/Team*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A team with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a team.*

      * **tags**
        * *0: Teams*

    * **patch**
      * *description: Updates the name, description, and/or members for the specified team.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/teamID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/TeamUpdate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *teamID: 03891d70-ea86-403e-8463-113917fd0355*

              * **schema**
                * **properties**
                  * **teamID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: teamID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A team with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Updates the name, description, and/or members of a team*

      * **tags**
        * *0: Teams*

  * **/v1/teams/{teamID}/accessControls**
    * **get**
      * *description: Return all the roles on the resource type, which include all grants of the given resource*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/teamID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/ResourceRole*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Get RBAC access information about the team*

      * **tags**
        * *0: Teams*

    * **patch**
      * *description: Grant or revoke grants on roles of the resource*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/teamID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/ControlAccessAction*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Update the RBAC grants on the team*

      * **tags**
        * *0: Teams*

  * **/v1/teams/{teamID}/identityRoles**
    * **get**
      * *description: Return granted roles to the team*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/teamID*

        * **1**
          * *description: Show only granted roles by resource type*

          * *in: query*

          * *name: resourceType*

          * **schema**
            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/IdentityRole*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Get granted roles to the team*

      * **tags**
        * *0: Teams*

  * **/v1/users**
    * *description: The \`users\` endpoint is used to manage users.*

    * **get**
      * *description: Returns a list of users in the current organization.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *description: Show only users with an email address matching this value or regular expression.*

          * *in: query*

          * *name: email*

          * **schema**
            * *type: string*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/User*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists the users in the current organization.*

      * **tags**
        * *0: Users*

    * **post**
      * *description: Adds a user already known to the portal to the current organization.

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * **properties**
                * **email**
                  * *description: The email address of the user to add to the organization.*

                  * *format: email*

                  * *type: string*

              * **required**
                * *0: email*

              * *type: object*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: User with the specified email address not found*

        * **409**
          * *description: User is already a member*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Adds an existing user to the current organization*

      * **tags**
        * *0: Users*

  * **/v1/users/{userID}**
    * **delete**
      * *description: Removes the specified user from the organization.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/userID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *userID: 03891d70-ea86-403e-8463-113917fd0466*

              * **schema**
                * **properties**
                  * **userID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: userID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A user with the specified ID was not found or is not a member of the organization*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Removes a user from the organization*

      * **tags**
        * *0: Users*

    * **get**
      * *description: Returns information for the specified user.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/userID*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *email: alice\@abc.com*

                * *firstName: Alice*

                * *lastName: Jones*

                * *userID: c74bb6a6-0000-1000-9000-1d874fa277b1*

                * *userKind: Standard*

              * **schema**
                * *$ref: #/components/schemas/User*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A user with the specified ID was not found or is not a member of the organization*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a user.*

      * **tags**
        * *0: Users*

  * **/v1/users/{userID}/identityRoles**
    * **get**
      * *description: Return granted roles to the user

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/userID*

        * **1**
          * *description: Show only granted roles by resource type*

          * *in: query*

          * *name: resourceType*

          * **schema**
            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/IdentityRole*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Get granted roles to the user*

      * **tags**
        * *0: Users*

  * **/v1/users/current**
    * **get**
      * *description: Returns information about the current user (i.e., the user making the API call).

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *email: alice\@abc.com*

                * *firstName: Alice*

                * *lastName: Jones*

                * *userID: c74bb6a6-0000-1000-9000-1d874fa277b1*

                * *userKind: Standard*

              * **schema**
                * *$ref: #/components/schemas/User*

          * *description: OK*

      * *summary: Gets information about the current user*

      * **tags**
        * *0: Users*

  * **/v1/workspaceGroups**
    * *description: The \`workspaceGroups\` endpoint can be used to manage workspaces.*

    * **get**
      * *description: Returns a list of all of the workspace groups accessible to the user. Use the \`includeTerminated\` parameter to get a list of terminated workspace groups.
*

      * **parameters**
        * **0**
          * *description: To include any terminated workspace groups, set to \`true\`*

          * *in: query*

          * *name: includeTerminated*

          * **schema**
            * *type: boolean*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * **0**
                  * *createdAt: 2023-09-18T09:56:56Z*

                  * *name: demo-workspace-group*

                  * *projectID: 70ab4e59-0000-1000-9000-76a5b06ed9e3*

                  * *projectName: demo-project*

                  * *provider: AWS*

                  * *regionID: 7d6b3a5a-0000-1000-9000-d454af4c785c*

                  * *regionName: eu-central-1*

                  * *state: ACTIVE*

                  * *workspaceGroupID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **items**
                  * *$ref: #/components/schemas/WorkspaceGroup*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists the workspace groups the user can access*

      * **tags**
        * *0: Workspace Groups*

    * **post**
      * *description: Creates a new workspace group for the current user. You must specify the name, region ID, and firewall ranges for the workspace group in the API request body.

        You may use the admin user password to connect with any workspace of the group. The admin user password can be specified in the request body. If the admin user password is not specified in the API request, a password is generated and returned in the response object.
*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/WorkspaceGroupCreate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *workspaceGroupID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **adminPassword**
                    * *type: string*

                  * **workspaceGroupID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: workspaceGroupID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new workspace group*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}**
    * **delete**
      * *description: Terminates a workspace group with the specified workspace group ID. You must specify the workspace group ID in the API call.

        By default, you may only terminate empty workspace groups (a workspace group without workspaces). To terminate a workspace group with active workspaces, use the \`force\` parameter.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

        * **1**
          * *description: To terminate a workspace group even if it has active workspaces, set to \`true\`*

          * *in: query*

          * *name: force*

          * **schema**
            * *type: boolean*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *workspaceGroupID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **workspaceGroupID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: workspaceGroupID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace group with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Terminates a workspace group*

      * **tags**
        * *0: Workspace Groups*

    * **get**
      * *description: Returns information for the specified
        workspace group ID, in JSON format. You must specify the workspace group ID in the API call.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *createdAt: 2023-09-18T09:56:56Z*

                * *name: demo-workspace-group*

                * *projectID: 70ab4e59-0000-1000-9000-76a5b06ed9e3*

                * *projectName: demo-project*

                * *provider: AWS*

                * *regionID: 7d6b3a5a-0000-1000-9000-d454af4c785c*

                * *regionName: eu-central-1*

                * *state: ACTIVE*

                * *workspaceGroupID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * *$ref: #/components/schemas/WorkspaceGroup*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace group with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a workspace group*

      * **tags**
        * *0: Workspace Groups*

    * **patch**
      * *description: Updates workspace group information for the specified workspace group, including the name, admin password, and firewall ranges. Specify the workspace group's new parameters in the request body. You must specify the workspace group ID in the API call.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/WorkspaceGroupUpdate*

        * *description: Here's a sample of JSON data sent to the API in the request body.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *workspaceGroupID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **workspaceGroupID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: workspaceGroupID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace group with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Updates a workspace group*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/accessControls**
    * **get**
      * *description: Return all the roles on the resource type, which include all grants of the given resource*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/ResourceRole*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Get RBAC access information about the workspace group*

      * **tags**
        * *0: Workspace Groups*

    * **patch**
      * *description: Grant or revoke grants on roles of the resource*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/ControlAccessAction*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Update the RBAC grants on the workspace group*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/delegatedEntities**
    * **delete**
      * *description: Removes customer-provided entities from the list of entities that the workspace group's cloud workload identity can assume. Entities to remove can be specified in the request body, via query parameters, or both (values will be merged and deduplicated).*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

        * **1**
          * *description: Entities to remove. Supports comma-separated values or multiple parameters.*

          * *in: query*

          * *name: entities*

          * **schema**
            * *type: string*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/DelegatedEntitiesRemove*

        * *description: Optional request body to specify entities to remove.*

      * **responses**
        * **204**
          * *description: No Content*

        * **207**
          * **content**
            * **application/json**
              * **example**
                * **deleted**
                  * *0: arn:aws:iam::123456789012:role/singlestore-iceberg-readonly*

                * **failed**
                  * *0: arn:aws:iam::123456789012:role/singlestore-s3-pipelines-users-bucket-readonly*

              * **schema**
                * **properties**
                  * **deleted**
                    * **items**
                      * *type: string*

                    * *type: array*

                  * **failed**
                    * **items**
                      * *type: string*

                    * *type: array*

                * **required**
                  * *0: deleted*

                  * *1: failed*

                * *type: object*

          * *description: Multi-Status*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **403**
          * *description: Operation not supported for workspace group type or organization*

        * **409**
          * *description: Identity not configured for workspace group*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Removes entities that the workspace group's cloud workload identity can assume*

      * **tags**
        * *0: Workspace Groups*

        * *1: Delegated Entities*

    * **get**
      * *description: Returns the list of customer-provided entities, such as IAM roles, that the workspace group's cloud workload identity can assume to access customer resources.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/DelegatedEntity*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **403**
          * *description: Operation not supported for workspace group type or organization*

        * **409**
          * *description: Identity not configured for workspace group*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets the list of entities that the workspace group's cloud workload identity can assume*

      * **tags**
        * *0: Workspace Groups*

        * *1: Delegated Entities*

    * **post**
      * *description: Adds customer-provided entities, such as IAM roles, to the list of entities that the workspace group's cloud workload identity can assume.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **requestBody**
        * **content**
          * **application/json**
            * **example**
              * **entities**
                * *0: arn:aws:iam::987654321098:role/singlestore-iceberg-readonly*

                * *1: arn:aws:iam::987654321098:role/singlestore-s3-pipelines*

            * **schema**
              * *$ref: #/components/schemas/DelegatedEntitiesAppend*

        * *description: Specify the entities to add in the request body.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/DelegatedEntity*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **403**
          * *description: Operation not supported for workspace group type or organization*

        * **409**
          * *description: Identity not configured for workspace group*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Adds entities that the workspace group's cloud workload identity can assume*

      * **tags**
        * *0: Workspace Groups*

        * *1: Delegated Entities*

  * **/v1/workspaceGroups/{workspaceGroupID}/identity**
    * **get**
      * *description: Returns the cloud workload identity information associated with the workspace group. The identity format is determined by the cloud provider where the workspace group is hosted. For example, on AWS it's an IAM role ARN.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/CloudWorkloadIdentity*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Get the workspace group's cloud workload identity information*

      * **tags**
        * *0: Workspace Groups*

        * *1: Cloud Workload Identity*

  * **/v1/workspaceGroups/{workspaceGroupID}/privateConnections**
    * **get**
      * *description: Returns private connection information for the specified
        workspace group ID, in JSON format. You must specify the workspace group ID in the API call.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/PrivateConnection*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace group with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets private connection information for a workspace group*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/storage/DR/failback**
    * **patch**
      * *description: You must specify the workspace group ID of the group in the standby (secondary) region from which you are triggering the failback.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Starts failback to the primary region*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/storage/DR/failover**
    * **patch**
      * *description: You must specify the workspace group ID of the group in the inactive (primary) region from which you are triggering the failover.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Starts failover to the secondary region*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/storage/DR/regions**
    * **get**
      * *description: Returns a list of regions with regions IDs in JSON format. You must specify the workspace group ID of the group you are setting up for disaster recovery.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/Region*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about which regions you can setup as a disaster recovery backup*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/storage/DR/setup**
    * **post**
      * *description: You must specify the workspace group ID of the group you are setting up for disaster recovery and the region ID of your secondary region.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/StorageDRSetup*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Sets up Storage DR for the workspace group. Backup region and selected databases to be replicated are provided as part of the request.*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/storage/DR/startPreProvision**
    * **patch**
      * *description: You must specify the workspace group ID of the group in the primary region from which you are requesting to start pre-provision.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Start pre-provisioning from primary region*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/storage/DR/status**
    * **get**
      * *description: Returns the replication status of each database and the status of the latest Storage DR operation (Failover, Failback, etc.). You must specify the workspace group ID of the group that you are requesting status information for.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/StorageDRStatus*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about the storage DR status of the workspace group*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/storage/DR/stopPreProvision**
    * **patch**
      * *description: You must specify the workspace group ID of the group in the primary region from which you are requesting to stop pre-provision.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Stops pre-provisioning from primary region*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaceGroups/{workspaceGroupID}/storage/retentionPeriod**
    * **patch**
      * *description: Updates the continuous backup retention period for all existing and future databases on a workspace group.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/RetentionPeriodParams*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Updates the retention period for continuous backups*

      * **tags**
        * *0: Workspace Groups*

  * **/v1/workspaces**
    * *description: The \`workspaces\` endpoint can be used to manage workspaces.*

    * **get**
      * *description: Returns a list of all of the workspaces accessible to the user in the specified workspace group. You must specify the workspace group ID in the API call to list the workspaces in the group. Use the \`includeTerminated\` parameter to list the terminated workspaces.
*

      * **parameters**
        * **0**
          * *description: ID of the workspace group*

          * *in: query*

          * *name: workspaceGroupID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **1**
          * *description: To include any terminated workspaces, set to \`true\`*

          * *in: query*

          * *name: includeTerminated*

          * **schema**
            * *type: boolean*

        * **2**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * **0**
                  * *createdAt: 2023-09-18T09:56:56Z*

                  * *endpoint: 192.168.224.3:30342*

                  * *name: demo-workspace*

                  * *size: S-00*

                  * *state: ACTIVE*

                  * *workspaceGroupID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

                  * *workspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **items**
                  * *$ref: #/components/schemas/Workspace*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace group with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists the workspaces the user can access*

      * **tags**
        * *0: Workspaces*

    * **post**
      * *description: Creates a new workspace for the current user in the specified workspace group. You must specify the name of the workspace and the workspace group ID in the request body. Once a workspace is created, you can neither change its name nor its workspace group. See \[Workspaces]\(https\://docs.singlestore.com/managed-service/en/reference/management-api.html#workspaces-729524) for more information.
        This API call does not take any request parameters.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/WorkspaceCreate*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *workspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **workspaceID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: workspaceID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new workspace*

      * **tags**
        * *0: Workspaces*

  * **/v1/workspaces/{workspaceID}**
    * **delete**
      * *description: Terminates a workspace with the specified workspace ID. You must specify the workspace ID in the API call.

        All the databases attached to the workspace are detached when the workspace is terminated.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *workspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **workspaceID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: workspaceID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Terminates a workspace*

      * **tags**
        * *0: Workspaces*

    * **get**
      * *description: Returns workspace information for the specified workspace ID, in JSON format. You must specify the workspace ID in the API call.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

        * **1**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *createdAt: 2023-09-18T09:56:56Z*

                * *endpoint: 192.168.224.3:30342*

                * *name: demo-workspace*

                * *size: S-00*

                * *state: ACTIVE*

                * *workspaceGroupID: 7d6a4a5a-0000-1000-9000-d454af4c785b*

                * *workspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * *$ref: #/components/schemas/Workspace*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information about a workspace*

      * **tags**
        * *0: Workspaces*

    * **patch**
      * *description: Updates workspace information for the specified workspace, including the size. Specify the workspace's new parameters in the request body. You must specify the workspace ID in the API call.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/WorkspaceUpdate*

        * *description: Here's a sample of JSON data sent to the API in the request body.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *workspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **workspaceID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: workspaceID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace with the specified ID was not found*

        * **409**
          * *description: Request conflict*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Updates information about a workspace*

      * **tags**
        * *0: Workspaces*

  * **/v1/workspaces/{workspaceID}/delegatedEntities**
    * **delete**
      * *description: Performs the same operation as the workspace group delegated entities DELETE endpoint. Removing entities through this workspace endpoint will update the delegated entities configuration for the entire workspace group. Entities to remove can be specified in the request body, via query parameters, or both (values will be merged and deduplicated).*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

        * **1**
          * *description: Entities to remove. Supports comma-separated values or multiple parameters.*

          * *in: query*

          * *name: entities*

          * **schema**
            * *type: string*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/DelegatedEntitiesRemove*

        * *description: Optional request body to specify entities to remove.*

      * **responses**
        * **204**
          * *description: No Content*

        * **207**
          * **content**
            * **application/json**
              * **example**
                * **deleted**
                  * *0: arn:aws:iam::123456789012:role/singlestore-iceberg-readonly*

                * **failed**
                  * *0: arn:aws:iam::123456789012:role/singlestore-s3-pipelines-users-bucket-readonly*

              * **schema**
                * **properties**
                  * **deleted**
                    * **items**
                      * *type: string*

                    * *type: array*

                  * **failed**
                    * **items**
                      * *type: string*

                    * *type: array*

                * **required**
                  * *0: deleted*

                  * *1: failed*

                * *type: object*

          * *description: Multi-Status*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **403**
          * *description: Operation not supported for workspace type or organization*

        * **409**
          * *description: Identity not configured for workspace*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Removes entities that the workspace's cloud workload identity can assume*

      * **tags**
        * *0: Workspaces*

        * *1: Delegated Entities*

    * **get**
      * *description: Returns the same list of delegated entities as the workspace group delegated entities endpoint. The workspace inherits and operates on the delegated entities configuration from its parent workspace group.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/DelegatedEntity*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **403**
          * *description: Operation not supported for workspace type or organization*

        * **409**
          * *description: Identity not configured for workspace*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets the list of entities that the workspace's cloud workload identity can assume*

      * **tags**
        * *0: Workspaces*

        * *1: Delegated Entities*

    * **post**
      * *description: Performs the same operation as the workspace group delegated entities POST endpoint. Adding entities through this workspace endpoint will update the delegated entities configuration for the entire workspace group.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

      * **requestBody**
        * **content**
          * **application/json**
            * **example**
              * **entities**
                * *0: arn:aws:iam::987654321098:role/singlestore-iceberg-readonly*

                * *1: arn:aws:iam::987654321098:role/singlestore-s3-pipelines*

            * **schema**
              * *$ref: #/components/schemas/DelegatedEntitiesAppend*

        * *description: Specify the entities to add in the request body.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/DelegatedEntity*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **403**
          * *description: Operation not supported for workspace type or organization*

        * **409**
          * *description: Identity not configured for workspace*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Adds entities that the workspace's cloud workload identity can assume*

      * **tags**
        * *0: Workspaces*

        * *1: Delegated Entities*

  * **/v1/workspaces/{workspaceID}/identity**
    * **get**
      * *description: Returns the same cloud workload identity information as the workspace group's cloud workload identity endpoint. The workspace inherits the identity configuration from its parent workspace group.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/CloudWorkloadIdentity*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Get the workspace's cloud workload identity information*

      * **tags**
        * *0: Workspaces*

        * *1: Cloud Workload Identity*

  * **/v1/workspaces/{workspaceID}/privateConnections**
    * **get**
      * *description: Returns private connection information for the specified workspace ID, in JSON format. You must specify the workspace ID in the API call.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

        * **1**
          * *$ref: #/components/parameters/fields*

        * **2**
          * *description: ID of the workspace group*

          * *in: query*

          * *name: workspaceGroupID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/PrivateConnection*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets private connection information for a workspace*

      * **tags**
        * *0: Workspaces*

  * **/v1/workspaces/{workspaceID}/privateConnections/kai**
    * **get**
      * *description: Returns the information needed to create private connection to SingleStore Kai.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: workspaceID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/PrivateConnectionKaiInfo*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A private connection with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets information to create private connection to SingleStore Kai for a workspace*

      * **tags**
        * *0: Private Connections*

        * *1: Workspaces*

  * **/v1/workspaces/{workspaceID}/privateConnections/outboundAllowList**
    * **get**
      * *description: Returns the account ID which must be allowed for outbound connections.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/PrivateConnectionOutboundAllowList*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets the outbound allow list for a workspace*

      * **tags**
        * *0: Workspaces*

  * **/v1/workspaces/{workspaceID}/resume**
    * **post**
      * *description: Resumes a workspace with the specified workspace ID. You must specify the workspace ID in the API call.
*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/WorkspaceResume*

        * *description: Here's a sample of JSON data sent in the request body to the API.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *workspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **workspaceID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: workspaceID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Resumes a workspace*

      * **tags**
        * *0: Workspaces*

  * **/v1/workspaces/{workspaceID}/suspend**
    * **post**
      * *description: Suspends a workspace with the specified workspace ID. You must specify the workspace ID in the API call.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/workspaceID*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *workspaceID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **workspaceID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: workspaceID*

                * *type: object*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: A workspace with the specified ID was not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Suspends a workspace*

      * **tags**
        * *0: Workspaces*

  * **/v2/authorization/permissions**
    * **get**
      * *description: 

        This route is currently not supported by BYOC.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/PermissionDefinition*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists all permissions*

      * **tags**
        * *0: Authorization*

  * **/v2/authorization/permissions/{resourceType}**
    * **get**
      * *description: 

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/resourceType*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/PermissionDefinition*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists permissions for the given resource type*

      * **tags**
        * *0: Authorization*

  * **/v2/authorization/roles**
    * **get**
      * *description: 

        This route is currently not supported by BYOC.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/RoleDefinitionV2*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists all roles*

      * **tags**
        * *0: Authorization*

    * **post**
      * *description: 

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/RoleCreateV2*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/RoleDefinitionV2*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new role*

      * **tags**
        * *0: Authorization*

  * **/v2/authorization/roles/{role}**
    * **delete**
      * *description: 

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/role*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *type: boolean*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Resource not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a role*

      * **tags**
        * *0: Authorization*

    * **get**
      * *description: 

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/role*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/RoleDefinitionV2*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Resource not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets a role*

      * **tags**
        * *0: Authorization*

    * **put**
      * *description: 

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/role*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/RoleReplaceV2*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/RoleDefinitionV2*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Resource not found*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Replaces a role*

      * **tags**
        * *0: Authorization*

  * **/v2/organizations/{organizationID}/workspaceGroups/{workspaceGroupID}/metrics**
    * **get**
      * *description: Returns metrics for the specified workspace group ID, in \[OpenMetrics]\(https\://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md) compatible format. You must specify the organization ID and workspace group ID in the API call. To fetch the organization id use the /v1/organizations/current endpoint.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/organizationID*

        * **1**
          * *$ref: #/components/parameters/workspaceGroupID*

      * **responses**
        * **200**
          * **content**
            * **text/plain**
              * *example: # TYPE singlestoredb\_cloud\_threads\_running gauge
                \# singlestoredb\_cloud\_threads\_running{extractor="monitoring-customer-prd/memsql-exporter",node="node-3337afc7-443e-4126-b784-413903527186-aggregator-0",role="CA",workspace\_group\_id="3337afc7-443e-4126-b784-413903527186",workspace\_name="singlestore-central"} 1*

              * **schema**
                * *type: string*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Gets metrics for a workspace group*

      * **tags**
        * *0: Metrics*

  * **/v2/regions**
    * **get**
      * *description: Returns a list of valid regions for the user that support workspaces, including the region code and provider for each region.*

      * **parameters**
        * **0**
          * *$ref: #/components/parameters/fields*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * **0**
                  * *provider: GCP*

                  * *region: US West 1 (Oregon)*

                  * *regionName: us-west1*

                * **1**
                  * *provider: AWS*

                  * *region: Europe Central 1 (Frankfurt)*

                  * *regionName: eu-central-1*

                * **2**
                  * *provider: AWS*

                  * *region: Asia Pacific Southeast 2 (Sydney)*

                  * *regionName: ap-southeast-2*

              * **schema**
                * **items**
                  * *$ref: #/components/schemas/RegionV2*

                * *type: array*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: Lists all of the regions for the user that support workspaces*

      * **tags**
        * *0: Regions*

  * **/v2/sharedtier/virtualClusters**
    * **get**
      * *description: Returns a list of all Shared Edition deployments (starter clusters) for the current user.

        This route is currently not supported by BYOC.*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **items**
                  * *$ref: #/components/schemas/SharedTierVirtualCluster*

                * *type: array*

          * *description: OK*

        * **400**
          * *description: Invalid request*

        * **401**
          * *description: Unauthorized*

        * **429**
          * *description: Too many requests*

        * **500**
          * *description: Internal server error*

      * *summary: List all Shared Edition deployments (starter clusters)*

      * **tags**
        * *0: SharedTier*

    * **post**
      * *description: Creates a new Shared Edition deployment (starter cluster) for the current user. You must specify a name, region ID, and firewall range(s) for the starter cluster in the API request body.

        This route is currently not supported by BYOC.*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/SharedTierCreateVirtualCluster*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **example**
                * *virtualClusterID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

              * **schema**
                * **properties**
                  * **virtualClusterID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: virtualClusterID*

                * *type: object*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new Shared Edition deployment (starter cluster)*

      * **tags**
        * *0: SharedTier*

  * **/v2/sharedtier/virtualClusters/{virtualClusterID}**
    * **delete**
      * *description: Deletes a Shared Edition deployment (starter cluster) for the specified ID. You must specify the ID of the starter cluster in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualClusterID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *type: boolean*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a Shared Edition deployment (starter cluster)*

      * **tags**
        * *0: SharedTier*

    * **get**
      * *description: Returns information about a Shared Edition deployment (starter cluster) with the specified ID. You must specify the ID of the starter cluster in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualClusterID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *$ref: #/components/schemas/SharedTierVirtualCluster*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **404**
          * *description: Not found*

        * **500**
          * *description: Internal server error*

      * *summary: Returns information about a Shared Edition deployment (starter cluster)*

      * **tags**
        * *0: SharedTier*

  * **/v2/sharedtier/virtualClusters/{virtualClusterID}/users**
    * **post**
      * *description: Creates a new user in a Shared Edition deployment (starter cluster) with the specified ID. You must specify the ID of the starter cluster in the API call. You can specify a password for the user in the request body. If a password is not specified, a password is automatically generated and returned in the API response.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualClusterID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/SharedTierCreateUser*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * **example**
                  * *password: Auto-generated-password1!*

                  * *userID: 7d6b3a5a-0000-1000-9000-d454af4c785b*

                * **properties**
                  * **password**
                    * *type: string*

                  * **userID**
                    * *format: uuid*

                    * *type: string*

                * **required**
                  * *0: userID*

                  * *1: password*

                * *type: object*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Creates a new user in a Shared Edition deployment (starter cluster)*

      * **tags**
        * *0: SharedTier*

  * **/v2/sharedtier/virtualClusters/{virtualClusterID}/users/{userID}**
    * **delete**
      * *description: Deletes a user with the specified user ID from a Shared Edition deployment (starter cluster). You must specify the ID of the starter cluster and the user in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualClusterID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **1**
          * *in: path*

          * *name: userID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *type: boolean*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Deletes a user from a Shared Edition deployment (starter cluster)*

      * **tags**
        * *0: SharedTier*

    * **patch**
      * *description: Updates a user in a Shared Edition deployment (starter cluster) with the specified user ID. You must specify the ID of the starter cluster and the user in the API call.

        This route is currently not supported by BYOC.*

      * **parameters**
        * **0**
          * *in: path*

          * *name: virtualClusterID*

          * **schema**
            * *format: uuid*

            * *type: string*

        * **1**
          * *in: path*

          * *name: userID*

          * **schema**
            * *format: uuid*

            * *type: string*

      * **requestBody**
        * **content**
          * **application/json**
            * **schema**
              * *$ref: #/components/schemas/SharedTierUpdateUser*

      * **responses**
        * **200**
          * **content**
            * **application/json**
              * **schema**
                * *type: boolean*

          * *description: OK*

        * **401**
          * *description: Unauthorized*

        * **500**
          * *description: Internal server error*

      * *summary: Updates a user in a Shared Edition deployment (starter cluster)*

      * **tags**
        * *0: SharedTier*

* **security**
  * **0**
    * **ApiKeyAuth**


* **servers**
  * **0**
    * *url: https\://api.singlestore.com*

* **tags**
  * **0**
    * *description: The authorization API is available only for organizations where the 'RBACRoleV2' feature flag is enabled.
*

    * *name: Authorization*

***

Modified at: April 11, 2024

Source: [/cloud/reference/management-api/reference/](https://docs.singlestore.com/cloud/reference/management-api/reference/)

(An index of the documentation is available at /llms.txt)