> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arc.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create workspaces

> Creates a new workspaces object with the specified parameters.



## OpenAPI

````yaml 26.4/self-hosted/en/api-reference/openapi.json POST /workspaces
openapi: 3.0.1
info:
  title: RSSBus OpenAPI
  version: 26.4.9790.0
servers:
  - url: '{baseUrl}'
    variables:
      baseUrl:
        default: https://arc.example.com/api.rsc
        description: >-
          Base URL of your Arc instance, including scheme and application path
          (e.g. https://arc.example.com/api.rsc).
security: []
paths:
  /workspaces:
    post:
      tags:
        - workspaces
      summary: Create workspaces
      description: Creates a new workspaces object with the specified parameters.
      operationId: createworkspaces
      requestBody:
        description: The workspaces entity to post
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workspaces'
        required: true
      responses:
        '201':
          description: workspaces created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspaces'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CDataError'
      security:
        - authtoken_header: []
        - basic: []
        - authtoken_query: []
components:
  schemas:
    workspaces:
      type: object
      properties:
        Workspaceid:
          description: The workspace Id.
          type: string
        ArchiveDestination:
          description: >-
            The type of storage location where archived transactions and files
            should be stored (such as local file system or S3). Available values
            are 'LocalDisk, S3'.
          type: string
        ArchiveFolder:
          description: >-
            The file path or folder location where Arc stores archived
            transaction logs and processed files for long-term retention.
          type: string
        AutoTaskType:
          description: >-
            The type of automated maintenance task to run. Available values are
            'Delete, Archive'.
          type: string
        AutoTaskInterval:
          description: How many days of records to keep.
          type: string
        CleanupReceiveFolder:
          description: Include files in Receive folders in cleanup operations.
          type: boolean
        CleanupSendFolder:
          description: Include files in Send folders in cleanup operations.
          type: boolean
        CleanupSentFolder:
          description: Include files in Sent folders in cleanup operations.
          type: boolean
        CleanupTransactions:
          description: Include transactions in cleanup operations.
          type: boolean
        EmailSendGridURL:
          description: >-
            The SendGrid API endpoint URL used when sending email notifications
            through the SendGrid service.
          type: string
        EmailSendGridAPIKey:
          description: >-
            The API key required to authenticate with SendGrid for sending
            emails from Arc.
          type: string
        EmailProtocol:
          description: >-
            The email protocol to use for sending notifications. Available
            values are 'SMTP, SendGrid'.
          type: string
        NotifyEmail:
          description: >-
            Send an email to the specified email addresses when an error is
            encountered.
          type: boolean
        NotifyEmailFrom:
          description: The email address used as the sender of notification emails.
          type: string
        NotifyEmailTo:
          description: A comma-separated list of notification email recipients.
          type: string
        NotifyEmailSubject:
          description: The notification email subject.
          type: string
        AllowArcScriptInAlertsSubject:
          description: >-
            Whether to evaluate ArcScript expressions in the notification email
            subject.
          type: boolean
        MaxFilesPerPort:
          description: >-
            The maximum number of files sent by each thread assigned to the
            connector.
          type: string
        MaxWorkersPerPort:
          description: >-
            The number of worker threads allocated to the connector for parallel
            processing.
          type: string
        SMTPServer:
          description: The host name or IP address of your SMTP server.
          type: string
        SMTPUser:
          description: The username to authenticate to your SMTP server.
          type: string
        SMTPPassword:
          description: The password to authenticate to your SMTP server.
          type: string
        SMTPPort:
          description: The port of your SMTP server.
          type: string
        SMTPSSLMode:
          description: The SSL mode of your SMTP server.
          type: string
        Other:
          description: >-
            The list of properties above is not comprehensive. You can use the
            API to set any profile property not listed above, using the same
            name/value format. All available profile default properties are
            returned in a GET request. You do not need to include an Other
            property when using additional settings that are not listed here.
          type: string
      required:
        - Workspaceid
    CDataError:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CDataInError'
    CDataInError:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
  securitySchemes:
    authtoken_header:
      type: apiKey
      in: header
      name: x-cdata-authtoken
    basic:
      scheme: basic
      type: http
    authtoken_query:
      type: apiKey
      in: query
      name: '@authtoken'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.