Skip to main content
Version: latest

Create workspace

POST 
/v1/workspaces

Create workspace

Request​

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    metadata

    object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

    property name*string
    creationTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    deletionTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    labels

    object

    Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    property name*string
    lastModifiedTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    namestring

    Name of the resource.

    uidstring

    UID is the unique identifier generated for the resource. This is not an input field for any request.

    spec

    Workspace specifications

    clusterNamespaces

    undefined[]

  • Array [

    • image

    Workspace namespace image information

    blackListedImagesstring[]
    isRegexboolean
    namestring

    namespaceResourceAllocation

    Workspace namespace resource allocation

    clusterResourceAllocations

    undefined[]

  • Array [

    • clusterUidstring

    resourceAllocation

    Workspace resource allocation

    cpuCoresnumber

    Possible values: >= -1

    memoryMiBnumber

    Possible values: >= -1

  • ]

    • defaultResourceAllocation

    Workspace resource allocation

    cpuCoresnumber

    Possible values: >= -1

    memoryMiBnumber

    Possible values: >= -1

  • ]

    • clusterRbacs

    object[]

  • Array [

    • metadata

    object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

    property name*string
    creationTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    deletionTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    labels

    object

    Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    property name*string
    lastModifiedTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    namestring

    Name of the resource.

    uidstring

    UID is the unique identifier generated for the resource. This is not an input field for any request.

    spec

    object

    Cluster RBAC spec

    bindings

    object[]

  • Array [

    • namespacestring

    role

    object

    Cluster role ref

    kindstring

    Possible values: [Role, ClusterRole]

    namestring

    subjects

    object[]

  • Array [

    • namestring
    namespacestring
    typestring

    Possible values: [User, Group, ServiceAccount]

  • ]

    • typestring

    Possible values: [RoleBinding, ClusterRoleBinding]

  • ]

    • relatedObject

    object

    Object for which the resource is related

    kindstring

    Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

    namestring
    uidstring

    status

    Cluster rbac status

    errors

    undefined[]

  • Array [

    • msgstring
    namestring
    resourceTypestring

  • ]

  • ]

    • clusterRefs

    undefined[]

  • Array [

    • clusterNamestring
    clusterUidstring

  • ]

    • policies

    Workspace policies

    backupPolicy

    Cluster backup config

    backupConfig

    Cluster backup config

    backupLocationNamestring
    backupLocationUidstring
    backupNamestring
    backupPrefixstring
    durationInHoursint64
    includeAllDisksboolean
    includeClusterResourcesboolean
    locationTypestring
    namespacesstring[]

    schedule

    Cluster feature schedule

    scheduledRunTimestring
    clusterUidsstring[]
    includeAllClustersboolean

    quota

    Workspace resource quota

    resourceAllocation

    Workspace resource allocation

    cpuCoresnumber

    Possible values: >= -1

    memoryMiBnumber

    Possible values: >= -1

Responses​

Created successfully

Response Headers

  • AuditUid

    string

    Audit uid for the request

Schema

    uidstringrequired
Loading...