Workspaces

→

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

summary:

Create workspace

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "clusterNamespaces": [
      {
        "image": {
          "blackListedImages": [
            "string"
          ]
        },
        "isRegex": "boolean",
        "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",
          "lastModifiedTimestamp": "date-time",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "selfLink": "string",
          "uid": "string"
        },
        "spec": {
          "bindings": [
            {
              "namespace": "string",
              "role": {
                "kind": "string",
                "name": "string"
              },
              "subjects": [
                {
                  "name": "string",
                  "namespace": "string",
                  "type": "string"
                }
              ],
              "type": "string"
            }
          ],
          "relatedObject": {
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        },
        "status": {
          "errors": [
            {
              "msg": "string",
              "name": "string",
              "resourceType": "string"
            }
          ]
        }
      }
    ],
    "clusterRefs": [
      {
        "clusterName": "string",
        "clusterUid": "string"
      }
    ],
    "policies": {
      "backupPolicy": {
        "backupConfig": {
          "backupLocationUid": "string",
          "backupName": "string",
          "backupPrefix": "string",
          "durationInHours": "number",
          "includeAllDisks": "boolean",
          "includeClusterResources": "boolean",
          "locationType": "string",
          "namespaces": [
            "string"
          ],
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "clusterUids": [
          "string"
        ],
        "includeAllClusters": "boolean"
      }
    },
    "quota": {
      "resourceAllocation": {
        "cpuCores": "number",
        "memoryMiB": "number"
      }
    }
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/workspaces/teams/{teamUid}/roles

summary:

Returns the specified team's workspaces and roles data

Path parameters:

Name	Type	Description	Required
teamUid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "projects": [
    {
      "name": "string",
      "uid": "string",
      "workspaces": [
        {
          "inheritedRoles": [
            {
              "name": "string",
              "uid": "string"
            }
          ],
          "name": "string",
          "roles": [
            {
              "name": "string",
              "uid": "string"
            }
          ],
          "uid": "string"
        }
      ]
    }
  ]
}

→

https://api.spectrocloud.com/v1/workspaces/teams/{teamUid}/roles

summary:

Updates the workspace roles for the specified team

Path parameters:

Name	Type	Description	Required
teamUid	string		yes

Body

{
  "workspaces": [
    {
      "roles": [
        "string"
      ],
      "uid": "string"
    }
  ]
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/workspaces/users/{userUid}/roles

summary:

Returns the specified User workspaces and Roles information

description:

Returns a User with workspaces and roles

Path parameters:

Name	Type	Description	Required
userUid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "projects": [
    {
      "name": "string",
      "uid": "string",
      "workspaces": [
        {
          "inheritedRoles": [
            {
              "name": "string",
              "uid": "string"
            }
          ],
          "name": "string",
          "roles": [
            {
              "name": "string",
              "uid": "string"
            }
          ],
          "uid": "string"
        }
      ]
    }
  ]
}

→

https://api.spectrocloud.com/v1/workspaces/users/{userUid}/roles

summary:

Updates the workspace roles for user

description:

User is updated with workspace roles

Path parameters:

Name	Type	Description	Required
userUid	string		yes

Body

{
  "workspaces": [
    {
      "roles": [
        "string"
      ],
      "uid": "string"
    }
  ]
}

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Validates the workspace name

Parameters:

Name	Type	Description	Required
name	string		yes

HTTP code: 204
Description: Ok reponse without content

→

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}

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",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "clusterNamespaces": [
      {
        "image": {
          "blackListedImages": [
            "string"
          ]
        },
        "isRegex": "boolean",
        "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",
          "lastModifiedTimestamp": "date-time",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "selfLink": "string",
          "uid": "string"
        },
        "spec": {
          "bindings": [
            {
              "namespace": "string",
              "role": {
                "kind": "string",
                "name": "string"
              },
              "subjects": [
                {
                  "name": "string",
                  "namespace": "string",
                  "type": "string"
                }
              ],
              "type": "string"
            }
          ],
          "relatedObject": {
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        },
        "status": {
          "errors": [
            {
              "msg": "string",
              "name": "string",
              "resourceType": "string"
            }
          ]
        }
      }
    ],
    "clusterRefs": [
      {
        "clusterName": "string",
        "clusterUid": "string"
      }
    ],
    "policies": {
      "backupPolicy": {
        "backupConfig": {
          "backupLocationUid": "string",
          "backupName": "string",
          "backupPrefix": "string",
          "durationInHours": "number",
          "includeAllDisks": "boolean",
          "includeClusterResources": "boolean",
          "locationType": "string",
          "namespaces": [
            "string"
          ],
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "clusterUids": [
          "string"
        ],
        "includeAllClusters": "boolean"
      }
    },
    "quota": {
      "resourceAllocation": {
        "cpuCores": "number",
        "memoryMiB": "number"
      }
    }
  },
  "status": {
    "errors": [
      {
        "clusterUid": "string",
        "msg": "string",
        "name": "string",
        "resourceType": "string"
      }
    ]
  }
}

→

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

summary:

Delete workspace backup

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "clusterConfigs": [
    {
      "backupName": "string",
      "clusterUid": "string"
    }
  ],
  "requestUid": "string"
}

HTTP code: 204
Description: The resource was deleted successfully

→

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

summary:

Returns the workspace backup result

Parameters:

Name	Type	Description	Required
backupRequestUid	string		no

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",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "config": {
      "backupConfig": {
        "backupLocationUid": "string",
        "backupName": "string",
        "backupPrefix": "string",
        "durationInHours": "number",
        "includeAllDisks": "boolean",
        "includeClusterResources": "boolean",
        "locationType": "string",
        "namespaces": [
          "string"
        ],
        "schedule": {
          "scheduledRunTime": "string"
        }
      },
      "clusterUids": [
        "string"
      ],
      "includeAllClusters": "boolean"
    },
    "workspaceUid": "string"
  },
  "status": {
    "workspaceBackupStatuses": [
      {
        "actor": {
          "actorType": "string",
          "uid": "string"
        },
        "requestUid": "string",
        "workspaceBackupConfig": {
          "backupName": "string",
          "backupState": {
            "deleteState": "string",
            "state": "string"
          },
          "backupTime": "date-time",
          "clusterBackupRefs": [
            {
              "backupStatusMeta": {
                "backupName": "string",
                "backupState": {
                  "backupTime": "date-time",
                  "deleteState": "string",
                  "msg": "string",
                  "state": "string"
                },
                "backupedNamespaces": [
                  "string"
                ],
                "expiryDate": "date-time"
              },
              "backupUid": "string",
              "clusterName": "string",
              "clusterUid": "string"
            }
          ],
          "config": {
            "backupName": "string",
            "durationInHours": "number",
            "includeAllDisks": "boolean",
            "includeClusterResources": "boolean",
            "namespaces": [
              "string"
            ]
          },
          "requestTime": "date-time"
        }
      }
    ]
  }
}

→

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

summary:

Create workspace backup settings

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "backupConfig": {
    "backupLocationUid": "string",
    "backupName": "string",
    "backupPrefix": "string",
    "durationInHours": "number",
    "includeAllDisks": "boolean",
    "includeClusterResources": "boolean",
    "locationType": "string",
    "namespaces": [
      "string"
    ],
    "schedule": {
      "scheduledRunTime": "string"
    }
  },
  "clusterUids": [
    "string"
  ],
  "includeAllClusters": "boolean"
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Update workspace backup settings

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "backupConfig": {
    "backupLocationUid": "string",
    "backupName": "string",
    "backupPrefix": "string",
    "durationInHours": "number",
    "includeAllDisks": "boolean",
    "includeClusterResources": "boolean",
    "locationType": "string",
    "namespaces": [
      "string"
    ],
    "schedule": {
      "scheduledRunTime": "string"
    }
  },
  "clusterUids": [
    "string"
  ],
  "includeAllClusters": "boolean"
}

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Create On demand Workspace Backup

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "backupConfig": {
    "backupLocationUid": "string",
    "backupName": "string",
    "backupPrefix": "string",
    "durationInHours": "number",
    "includeAllDisks": "boolean",
    "includeClusterResources": "boolean",
    "locationType": "string",
    "namespaces": [
      "string"
    ],
    "schedule": {
      "scheduledRunTime": "string"
    }
  },
  "clusterUids": [
    "string"
  ],
  "includeAllClusters": "boolean"
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Updates the specified workspace namespaces

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

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

HTTP code: 204
Description: The resource was updated 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",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "bindings": [
      {
        "namespace": "string",
        "role": {
          "kind": "string",
          "name": "string"
        },
        "subjects": [
          {
            "name": "string",
            "namespace": "string",
            "type": "string"
          }
        ],
        "type": "string"
      }
    ],
    "relatedObject": {
      "kind": "string",
      "name": "string",
      "uid": "string"
    }
  },
  "status": {
    "errors": [
      {
        "msg": "string",
        "name": "string",
        "resourceType": "string"
      }
    ]
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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}/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",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "bindings": [
      {
        "namespace": "string",
        "role": {
          "kind": "string",
          "name": "string"
        },
        "subjects": [
          {
            "name": "string",
            "namespace": "string",
            "type": "string"
          }
        ],
        "type": "string"
      }
    ],
    "relatedObject": {
      "kind": "string",
      "name": "string",
      "uid": "string"
    }
  },
  "status": {
    "errors": [
      {
        "msg": "string",
        "name": "string",
        "resourceType": "string"
      }
    ]
  }
}

HTTP code: 204
Description: The resource was updated 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",
  "lastModifiedTimestamp": "date-time",
  "name": "string",
  "namespace": "string",
  "resourceVersion": "string",
  "selfLink": "string",
  "uid": "string"
}

HTTP code: 204
Description: The resource was updated successfully

deprecated→

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

summary:

Updates the specified workspace resource allocations

description:

Deprecated

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

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

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Returns the workspace restore result

Parameters:

Name	Type	Description	Required
restoreRequestUid	string		no

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",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "workspaceUid": "string"
  },
  "status": {
    "workspaceRestoreStatuses": [
      {
        "actor": {
          "actorType": "string",
          "uid": "string"
        },
        "requestUid": "string",
        "workspaceRestoreConfig": {
          "backupName": "string",
          "clusterRestoreRefs": [
            {
              "backupName": "string",
              "clusterName": "string",
              "clusterUid": "string",
              "restoreStatusMeta": {
                "msg": "string",
                "restoreTime": "date-time",
                "state": "string"
              },
              "restoreUid": "string"
            }
          ],
          "restoreState": {
            "deleteState": "string",
            "state": "string"
          },
          "restoreTime": "date-time"
        }
      }
    ]
  }
}

→

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

summary:

Create On demand Workspace Restore

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "backupRequestUid": "string",
  "restoreConfigs": [
    {
      "backupName": "string",
      "includeClusterResources": "boolean",
      "includeNamespaces": [
        "string"
      ],
      "preserveNodePorts": "boolean",
      "restorePVs": "boolean",
      "sourceClusterUid": "string"
    }
  ]
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

Edit on GitHub