> ## Documentation Index > Fetch the complete documentation index at: https://developers.dock.us/llms.txt > Use this file to discover all available pages before exploring further. # Create a workspace domain > Create a workspace domain ## OpenAPI ````yaml POST /workspace-domains openapi: 3.1.0 info: title: Dock API description: >- The Dock API is a RESTful API that allows you to interact with Dock in a programmatic way termsOfService: https://www.dock.us/legal/terms contact: name: API Support email: developers@dock.us license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 servers: - url: https://api.dock.us/{version} description: Production server variables: version: default: v1 enum: - v1 security: - bearerAuth: [] tags: - name: Status check description: API to check if the API is up - name: Accounts description: API to manage accounts - name: Assets description: API to manage assets - name: Files description: API to manage files - name: Tags description: API to manage tags - name: Users description: API to manage users - name: Workspaces description: API to manage workspaces - name: Templates description: API to manage templates - name: Workspace pages description: API to manage workspace pages - name: Workspace plans description: API to manage workspace plans - name: Workspace plan tasks description: API to manage workspace plan tasks - name: Workspace sections description: API to manage workspace sections paths: /workspace-domains: post: tags: - Workspace domains description: Create a workspace domain parameters: - $ref: '#/components/parameters/workspaceDomainProperties' requestBody: description: Workspace domain to create content: application/json: schema: type: object required: - domain - workspaceId - role properties: domain: type: string description: Domain to create example: example.com role: $ref: '#/components/schemas/WorkspaceRole' workspaceId: type: string description: ID of the workspace example: luI89ZCeEJuF responses: '200': description: Workspace domain created content: application/json: schema: type: object properties: data: type: object properties: workspaceDomain: $ref: '#/components/schemas/WorkspaceDomain' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' components: parameters: workspaceDomainProperties: name: properties in: query description: Select the workspace domain properties that should be returned schema: type: array items: type: string enum: - role - domain - createdAt - updatedAt schemas: WorkspaceRole: type: string description: Role of the user to access the workspace enum: - owner - editor - collaborator - viewer - commenter example: owner WorkspaceDomain: allOf: - $ref: '#/components/schemas/BaseObject' - type: object properties: role: $ref: '#/components/schemas/WorkspaceRole' domain: type: string description: Domain of the workspace user format: hostname example: dock.us BaseObject: type: object properties: id: $ref: '#/components/schemas/Id' updatedAt: type: string format: date-time description: Last updated date example: '2021-01-01T00:00:00.000Z' readOnly: true createdAt: type: string format: date-time description: Created at date example: '2021-01-01T00:00:00.000Z' readOnly: true Id: type: string description: Id of the object example: RiHO4e0Ju3DS readOnly: true responses: '400': description: >- The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing) content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - BAD_REQUEST description: A short code indicating the error code returned example: BAD_REQUEST message: type: string description: A human readable explanation of what went wrong example: >- The request could not be understood or was missing required parameters required: - code - message required: - error '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - UNAUTHORIZED description: A short code indicating the error code returned example: UNAUTHORIZED message: type: string description: A human readable explanation of what went wrong example: >- Access denied. You are not authorized to access this resource required: - code - message required: - error '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - FORBIDDEN description: A short code indicating the error code returned example: FORBIDDEN message: type: string description: A human readable explanation of what went wrong example: Access to this resource is restricted required: - code - message required: - error '404': description: The server cannot find the requested resource content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - NOT_FOUND description: A short code indicating the error code returned example: NOT_FOUND message: type: string description: A human readable explanation of what went wrong example: The requested resource could not be found required: - code - message required: - error '429': description: >- The user has sent too many requests in a given amount of time ("rate limiting") content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - RATE_LIMIT_EXCEEDED description: A short code indicating the error code returned example: RATE_LIMIT_EXCEEDED message: type: string description: A human readable explanation of what went wrong example: Rate limit exceeded. Please try again later required: - code - message required: - error '500': description: The server has encountered a situation it does not know how to handle content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: A short code indicating the error code returned example: INTERNAL_SERVER_ERROR message: type: string description: A human readable explanation of what went wrong example: >- The server has encountered a situation it does not know how to handle required: - code - message required: - error securitySchemes: bearerAuth: type: http scheme: bearer ````