How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Spectro Cloud workspaces API

The workspaces API from Spectro Cloud — 14 operation(s) for workspaces.

Spectro Cloud workspaces API is one of 42 APIs that Spectro Cloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 21 operations across 14 paths, and defines 61 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://edge-host-ip:5080.

21 operations 14 paths 61 schemas 3 DELETE6 GET5 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.spectrocloud.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Spectro Cloud workspaces API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

  • Authorization — JWT authorization token obtained using /v1/users/default/login API

Paths & Operations 21

Across 14 paths, the API surfaces 21 operations — 3 DELETE, 6 GET, 5 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

workspaces 21
POST
/v1/workspaces
Create workspace
v1WorkspacesCreate 1 param body → 201
GET
/v1/workspaces/teams/{teamUid}/roles
Returns the specified team's workspaces and roles data
v1TeamsWorkspaceGetRoles 2 params → 200
PUT
/v1/workspaces/teams/{teamUid}/roles
Updates the workspace roles for the specified team
v1TeamsWorkspaceRolesPut 2 params body → 204
GET
/v1/workspaces/users/{userUid}/roles
Returns the specified User workspaces and Roles information
v1UsersWorkspaceGetRoles 2 params → 200
PUT
/v1/workspaces/users/{userUid}/roles
Updates the workspace roles for user
v1UsersWorkspaceRolesPut 2 params body → 204
GET
/v1/workspaces/validate/name
Validates the workspace name
v1WorkspacesValidateName 2 params → 204
DELETE
/v1/workspaces/{uid}
Deletes the specified workspace
v1WorkspacesUidDelete 2 params → 204
GET
/v1/workspaces/{uid}
Returns the specified workspace
v1WorkspacesUidGet 2 params → 200
DELETE
/v1/workspaces/{uid}/backup
Delete workspace backup
v1WorkspaceOpsBackupDelete 2 params body → 204
GET
/v1/workspaces/{uid}/backup
Returns the workspace backup result
v1WorkspaceOpsBackupGet 3 params → 200
POST
/v1/workspaces/{uid}/backup
Create workspace backup settings
v1WorkspaceOpsBackupCreate 2 params body → 201
PUT
/v1/workspaces/{uid}/backup
Update workspace backup settings
v1WorkspaceOpsBackupUpdate 2 params body → 204
POST
/v1/workspaces/{uid}/backup/onDemand
Create On demand Workspace Backup
v1WorkspaceOpsBackupOnDemandCreate 2 params body → 201
PUT
/v1/workspaces/{uid}/clusterNamespaces
Updates the specified workspace namespaces
v1WorkspacesUidClusterNamespacesUpdate 2 params body → 204
POST
/v1/workspaces/{uid}/clusterRbacs
Create cluster rbac in workspace
v1WorkspacesClusterRbacCreate 2 params body → 201
DELETE
/v1/workspaces/{uid}/clusterRbacs/{clusterRbacUid}
Deletes the specified workspace cluster rbac
v1WorkspacesUidClusterRbacDelete 3 params → 204
PUT
/v1/workspaces/{uid}/clusterRbacs/{clusterRbacUid}
Updates the specified workspace cluster rbac
v1WorkspacesUidClusterRbacUpdate 3 params body → 204
PUT
/v1/workspaces/{uid}/meta
Updates the specified workspace meta
v1WorkspacesUidMetaUpdate 2 params body → 204
PUT
/v1/workspaces/{uid}/resourceAllocations
Updates the specified workspace resource allocations
v1WorkspacesUidResourceAllocationsUpdate 2 params body → 204
GET
/v1/workspaces/{uid}/restore
Returns the workspace restore result
v1WorkspaceOpsRestoreGet 3 params → 200
POST
/v1/workspaces/{uid}/restore/onDemand
Create On demand Workspace Restore
v1WorkspaceOpsRestoreOnDemandCreate 2 params body → 201

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are v1ClusterBackupConfig (11 properties), v1WorkspaceRestoreConfig (7 properties), v1ObjectMeta (7 properties), v1WorkspaceBackupStatusConfig (6 properties). Each schema is shown below with its type and property counts.

v1WorkspaceBackupConfig
object
Workspace backup config
3 properties
v1WorkspaceStatus
object
Workspace status
1 property
v1RelatedObject
object
Object for which the resource is related
3 properties
v1ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
7 properties
v1WorkspaceRestoreConfig
object
Workspace cluster restore config
7 properties 2 required
v1WorkspaceClusterRestoreConfig
object
Workspace cluster restore config
4 properties
v1Time
string
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 pack…
v1ClusterRbacSpec
object
Cluster RBAC spec
3 properties
v1ClusterRbac
object
Cluster RBAC role binding defintion
3 properties
v1Uid
object
1 property 1 required
v1WorkspaceBackupStatusMeta
object
Workspace backup status meta
3 properties
v1WorkspaceQuota
object
Workspace resource quota
1 property
v1ClusterBackupConfig
object
Cluster backup config
11 properties
v1WorkspaceScopeRoles
object
List all workspaces with the roles assigned to the users
1 property
v1WorkspaceClusterNamespacesEntity
object
Workspace cluster namespaces update entity
3 properties
v1WorkspaceRestoreStatusMeta
object
Workspace restore status meta
3 properties
v1WorkspaceClusterBackupResponse
object
Workspace cluster backup response
4 properties
v1BackupStatusMeta
object
Backup status meta
4 properties
v1WorkspaceError
object
Workspace error
4 properties
v1Workspace
object
Workspace information
3 properties
v1ClusterRbacStatus
object
Cluster rbac status
1 property
v1ClusterRbacSubjects
object
Cluster role ref
3 properties
v1ProjectsWorkspaces
object
List projects and its workspaces
3 properties
v1WorkspaceRolesUidSummary
object
2 properties
v1WorkspaceRestore
object
Workspace restore
3 properties
v1WorkspaceClusterRestoreResponse
object
Workspace cluster restore response
5 properties
v1WorkspaceSpec
object
Workspace specifications
5 properties
v1WorkspaceBackupStatus
object
Workspace backup status
1 property
v1WorkspaceRestoreSpec
object
Workspace restore spec
1 property
v1WorkspaceRolesPatch
object
2 properties
v1WorkspaceRestoreState
object
Workspace restore state
2 properties
v1WorkspaceNamespaceResourceAllocation
object
Workspace namespace resource allocation
2 properties
v1WorkspaceClusterRestoreState
object
Workspace cluster restore state
3 properties
v1ClusterFeatureSchedule
object
Cluster feature schedule
1 property
v1WorkspaceEntity
object
Workspace information
2 properties
v1WorkspaceResourceAllocationsEntity
object
Workspace resource allocation update entity
3 properties
v1WorkspaceBackupDeleteEntity
object
Cluster backup delete config
2 properties
v1WorkspaceBackupStatusConfig
object
Workspace backup status config
6 properties
v1WorkspaceRestoreStatus
object
Workspace restore status
1 property
v1WorkspacesRoles
object
Workspace users and their roles
4 properties
v1GpuConfig
object
GPU configuration for resource allocation
2 properties
v1WorkspacePolicies
object
Workspace policies
1 property
v1ClusterResourceAllocation
object
Workspace resource allocation
2 properties
v1WorkspaceBackupConfigEntity
object
Cluster backup config
3 properties
v1WorkspaceBackupClusterRef
object
Workspace backup cluster ref
2 properties
v1WorkspaceClusterBackupConfig
object
Workspace cluster backup config
6 properties
v1WorkspaceBackupSpec
object
Workspace backup spec
2 properties
v1WorkspaceBackupState
object
Workspace backup state
2 properties
v1BackupState
object
Backup state
4 properties
v1WorkspaceClusterNamespace
object
Workspace cluster namespace
4 properties
v1WorkspaceNamespaceImage
object
Workspace namespace image information
1 property
v1ClusterRoleRef
object
Cluster role ref
2 properties
v1ClusterFeatureActor
object
Compliance Scan actor
2 properties
v1WorkspaceClusterRef
object
Workspace cluster reference
2 properties
v1WorkspaceRestoreConfigEntity
object
Cluster restore config
2 properties 1 required
v1WorkspaceBackup
object
Workspace backup
3 properties
v1ClusterResourceError
object
Cluster resource error
3 properties
v1WorkspacesRolesPatch
object
1 property
v1IncludeClusterResourceMode
string
Specifies the scope of cluster-wide resources to include in the backup based on the flag'--include-cluster-resources': - "Always": --include-cluster-resources=…
v1WorkspaceResourceAllocation
object
Workspace resource allocation
3 properties
v1ClusterRbacBinding
object
Cluster RBAC binding
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spectro-cloud-workspaces-api-openapi.yml Raw ↑

Other APIs Spectro Cloud publishes across the network.

Spectro Cloud activations API
Spectro Cloud apiKeys API
Spectro Cloud appDeployments API
Spectro Cloud appProfiles API
Spectro Cloud audits API
Spectro Cloud auth API
Spectro Cloud cloudaccounts API
Spectro Cloud cloudconfigs API
Spectro Cloud clouds API
Spectro Cloud clustergroups API
Spectro Cloud clusterprofiles API
Spectro Cloud clusterTemplates API
Where this information came from

This is an independent, third-party profile of Spectro Cloud workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.