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

# Create deployment

> Create a new deployment with the specified cloud storage provider configuration.



## OpenAPI

````yaml /openapi/brms.json post /api/deployments
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/deployments:
    post:
      tags:
        - Deployments
      summary: Create deployment
      description: >-
        Create a new deployment with the specified cloud storage provider
        configuration.
      operationId: createDeployment
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Name of the deployment
                description:
                  type: string
                  nullable: true
                  description: Description of the deployment
                provider:
                  type: string
                  enum:
                    - aws_s3
                    - azure_storage
                    - google_cloud_storage
                  description: >-
                    Cloud storage provider type (aws_s3, azure_storage,
                    google_cloud_storage)
                configuration:
                  description: Provider-specific configuration settings
                secrets:
                  nullable: true
                  description: Provider-specific secrets (e.g., access keys, credentials)
              required:
                - name
                - provider
        required: true
      responses:
        '200':
          description: The newly created deployment
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique identifier of the deployment
                  name:
                    type: string
                    description: Name of the deployment
                  description:
                    type: string
                    description: Description of the deployment
                  provider:
                    type: string
                    enum:
                      - aws_s3
                      - azure_storage
                      - google_cloud_storage
                    description: >-
                      Cloud storage provider type (aws_s3, azure_storage,
                      google_cloud_storage)
                  configuration:
                    description: Provider-specific configuration settings
                  organisationId:
                    type: string
                    format: uuid
                    description: ID of the organisation this deployment belongs to
                  organisation:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier of the organisation
                      name:
                        type: string
                        description: Name of the organisation
                      displayName:
                        type: string
                        description: Display name of the organisation
                      onboarded:
                        type: boolean
                        description: Whether the organisation has completed onboarding
                      license:
                        type: string
                        description: License key of the organisation
                      licenseData:
                        description: License data details
                      url:
                        type: string
                        description: URL of the organisation
                      themeLogo:
                        type: string
                        description: Theme logo URL
                      themePrimaryColor:
                        type: string
                        description: Theme primary color
                      preferences:
                        description: Organisation preferences
                      createdAt:
                        type: string
                        description: Timestamp when the organisation was created
                      updatedAt:
                        type: string
                        description: Timestamp when the organisation was last updated
                      deletedAt:
                        type: string
                        description: Timestamp when the organisation was deleted
                    required:
                      - id
                      - name
                      - displayName
                      - onboarded
                      - themeLogo
                      - themePrimaryColor
                      - createdAt
                      - updatedAt
                    description: Organisation associated with the deployment
                  createdAt:
                    type: string
                    description: Timestamp when the deployment was created
                  updatedAt:
                    type: string
                    description: Timestamp when the deployment was last updated
                  deletedAt:
                    type: string
                    description: Timestamp when the deployment was deleted
                required:
                  - id
                  - name
                  - provider
                  - organisationId
                  - organisation
                  - createdAt
                  - updatedAt
                description: The newly created deployment
      security:
        - internalAuth: []
components:
  securitySchemes:
    internalAuth:
      type: http
      scheme: internal
      description: Cannot be used directly

````