Sign in
workspaces

Create a Workspace in the specified Organization

Create a new Workspace in the specified Organization.

post/v1/organizations/{organizationId}/workspaces

Path parameters

organizationIdstring required

The <code>id</code> of the Organization where you want to create the Workspace.

Request body

workspaceIdstring required

Unique identifier for the Workspace.

aliasstring

User-friendly alias for the Workspace.

descriptionstring

Brief description of the Workspace.

tagsstring[]

Tags associated with the Workspace.

Example request

{
  "workspaceId": "main",
  "alias": "Production Environment",
  "description": "Main production Workspace for customer data processing",
  "tags": [
    "production",
    "customer-data"
  ]
}

Response

The Workspace has been successfully created

workspaceIdstring required

Unique identifier for the Workspace.

region'us-west-2' | 'us-east-1' | 'us-east-2' | 'eu-central-1' | 'eu-central-2' | 'eu-west-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ca-central-1' | 'ap-northeast-1' | 'sa-east-1' | 'eu-west-1' | 'eu-west-3' required

AWS region where the Workspace is deployed.

leaderFQDNstring required

Fully Qualified Domain Name (FQDN) of the Workspace Leader.

state'Provisioning' | 'Active' | 'Inactive' | 'Failed' | 'Deprovisioning' required

Current state of the Workspace.

aliasstring

User-friendly alias for the Workspace.

descriptionstring

Brief description of the Workspace.

tagsstring[]

Tags associated with the Workspace.

Example response

{
  "workspaceId": "main",
  "leaderFQDN": "workspace-leader.example.com",
  "alias": "Production Environment",
  "description": "Main production Workspace for customer data processing",
  "tags": [
    "production",
    "customer-data"
  ]
}

Changes

Changed in 8 of the 42 revisions of this API.11517

  • bfa460b2aec33See the full diff
    • ●

      the request property's maxLength was set to 30

      request-property-max-length-set

    • ●

      the request property's maxLength was set to 255

      request-property-max-length-set

    • ●

      the / request property's maxLength was set to 30

      request-property-max-length-set

  • 9bda0eaca3454See the full diff
    • ●

      added the new ap-northeast-1 enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new eu-west-1 enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new eu-west-3 enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sa-east-1 enum value to the //// response property for the response status

      response-property-enum-value-added

  • 1ab82a0cc26d1See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

  • 0d907f2a36961See the full diff
    • ○

      removed the non-success response with the status

      response-non-success-status-removed

  • 00753fc6a7b0513See the full diff
    • ●

      added the new Active enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Deprovisioning enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Failed enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Inactive enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Provisioning enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      removed the Workspace-Active enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Cleanup-Completed enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Cleanup-Failed enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Cleanup-Requested enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Cleanup-Started enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Cleanup-Terraform-Completed enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Cleanup-Terraform-Failed enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Failed-Update enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Provisioned enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Provisioning enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Provisioning-Failed enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Requested enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the Workspace-Updated enum value from the //// response property for the response status

      response-property-enum-value-removed

  • db7f7dd086ea3See the full diff
    • ●

      removed the request property

      request-property-removed

    • ●

      added the new ap-southeast-1 enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new eu-central-2 enum value to the //// response property for the response status

      response-property-enum-value-added

  • bc63c2cca59c2See the full diff
    • ○

      the endpoint scheme security bearer was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security oauth2 was removed from the API

      api-security-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 914a71ae4db31See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog