Skip to main content

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 is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    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

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

    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 must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    uidstring

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

    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 is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    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

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

    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 must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    uidstring

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

    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...