Workspaces

→

https://api.spectrocloud.com/v1/workspaces

summary:

Create workspace

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "clusterNamespaces": [
      {
        "name": "string",
        "namespaceResourceAllocation": {
          "clusterResourceAllocations": [
            {
              "clusterUid": "string",
              "resourceAllocation": {
                "cpuCores": "number",
                "memoryMiB": "number"
              }
            }
          ],
          "defaultResourceAllocation": {
            "cpuCores": "number",
            "memoryMiB": "number"
          }
        }
      }
    ],
    "clusterRbacs": [
      {
        "metadata": {
          "annotations": "object",
          "creationTimestamp": "date-time",
          "deletionTimestamp": "date-time",
          "labels": "object",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "selfLink": "string",
          "uid": "string"
        },
        "spec": {
          "bindings": [
            {
              "createNamespace": "boolean",
              "namespace": "string",
              "role": {
                "kind": "string",
                "name": "string"
              },
              "subjects": [
                {
                  "name": "string",
                  "namespace": "string",
                  "type": "string"
                }
              ],
              "type": "string"
            }
          ],
          "isDefault": "boolean"
        }
      }
    ],
    "clusterRefs": [
      {
        "clusterName": "string",
        "clusterUid": "string"
      }
    ]
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/workspaces/{uid}

summary:

Returns the specified workspace

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "clusterNamespaces": [
      {
        "name": "string",
        "namespaceResourceAllocation": {
          "clusterResourceAllocations": [
            {
              "clusterUid": "string",
              "resourceAllocation": {
                "cpuCores": "number",
                "memoryMiB": "number"
              }
            }
          ],
          "defaultResourceAllocation": {
            "cpuCores": "number",
            "memoryMiB": "number"
          }
        }
      }
    ],
    "clusterRbacs": [
      {
        "metadata": {
          "annotations": "object",
          "creationTimestamp": "date-time",
          "deletionTimestamp": "date-time",
          "labels": "object",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "selfLink": "string",
          "uid": "string"
        },
        "spec": {
          "bindings": [
            {
              "createNamespace": "boolean",
              "namespace": "string",
              "role": {
                "kind": "string",
                "name": "string"
              },
              "subjects": [
                {
                  "name": "string",
                  "namespace": "string",
                  "type": "string"
                }
              ],
              "type": "string"
            }
          ],
          "isDefault": "boolean"
        }
      }
    ],
    "clusterRefs": [
      {
        "clusterName": "string",
        "clusterUid": "string"
      }
    ]
  },
  "status": {
    "errors": [
      {
        "clusterUid": "string",
        "msg": "string",
        "name": "string",
        "resourceType": "string"
      }
    ]
  }
}

→

https://api.spectrocloud.com/v1/workspaces/{uid}

summary:

Deletes the specified workspace

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/workspaces/{uid}/clusterRbacs

summary:

Create cluster rbac in workspace

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "bindings": [
      {
        "createNamespace": "boolean",
        "namespace": "string",
        "role": {
          "kind": "string",
          "name": "string"
        },
        "subjects": [
          {
            "name": "string",
            "namespace": "string",
            "type": "string"
          }
        ],
        "type": "string"
      }
    ],
    "isDefault": "boolean"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/workspaces/{uid}/clusterRbacs/{clusterRbacUid}

summary:

Updates the specified workspace cluster rbac

Path parameters:

Name	Type	Description	Required
uid	string		yes
clusterRbacUid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "bindings": [
      {
        "createNamespace": "boolean",
        "namespace": "string",
        "role": {
          "kind": "string",
          "name": "string"
        },
        "subjects": [
          {
            "name": "string",
            "namespace": "string",
            "type": "string"
          }
        ],
        "type": "string"
      }
    ],
    "isDefault": "boolean"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/workspaces/{uid}/clusterRbacs/{clusterRbacUid}

summary:

Deletes the specified workspace cluster rbac

Path parameters:

Name	Type	Description	Required
uid	string		yes
clusterRbacUid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/workspaces/{uid}/meta

summary:

Updates the specified workspace meta

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "annotations": "object",
  "creationTimestamp": "date-time",
  "deletionTimestamp": "date-time",
  "labels": "object",
  "name": "string",
  "namespace": "string",
  "resourceVersion": "string",
  "selfLink": "string",
  "uid": "string"
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/workspaces/{uid}/resourceAllocations

summary:

Updates the specified workspace resource allocations

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "clusterNamespaces": [
    {
      "name": "string",
      "namespaceResourceAllocation": {
        "clusterResourceAllocations": [
          {
            "clusterUid": "string",
            "resourceAllocation": {
              "cpuCores": "number",
              "memoryMiB": "number"
            }
          }
        ],
        "defaultResourceAllocation": {
          "cpuCores": "number",
          "memoryMiB": "number"
        }
      }
    }
  ],
  "clusterRefs": [
    {
      "clusterName": "string",
      "clusterUid": "string"
    }
  ]
}

HTTP code: 204
Description: The resource was updated successfully

Edit on GitHub