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

Codesphere workspaces API

The workspaces API from Codesphere — 21 operation(s) for workspaces.

Codesphere workspaces API is one of 10 APIs that Codesphere 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 an API reference.

This API exposes 25 operations across 21 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://cloud.codesphere.com/api.

25 operations 21 paths 4 schemas 3 DELETE9 GET2 PATCH10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://cloud.codesphere.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Codesphere workspaces API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 25

Across 21 paths, the API surfaces 25 operations — 3 DELETE, 9 GET, 2 PATCH, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

workspaces 25
GET
/workspaces/{workspaceId}
getWorkspace
workspaces-getWorkspace 1 param → 200400401404
PATCH
/workspaces/{workspaceId}
updateWorkspace
workspaces-updateWorkspace 1 param body → 200400401404
DELETE
/workspaces/{workspaceId}
deleteWorkspace
workspaces-deleteWorkspace 1 param → 200400401404
GET
/workspaces/{workspaceId}/status
getWorkspaceStatus
workspaces-getWorkspaceStatus 1 param → 200400401404
POST
/workspaces
createWorkspace
workspaces-createWorkspace body → 200400401
GET
/workspaces/team/{teamId}
listWorkspaces
workspaces-listWorkspaces 1 param → 200400401
POST
/workspaces/{workspaceId}/landscape/deploy/{profile}
deployLandscape
workspaces-deployLandscape-1 2 params → 200400401404
POST
/workspaces/{workspaceId}/landscape/deploy
deployLandscape
workspaces-deployLandscape 1 param → 200400401404
DELETE
/workspaces/{workspaceId}/landscape/teardown
teardownLandscape
workspaces-teardownLandscape 1 param → 200400401404
PATCH
/workspaces/{workspaceId}/landscape/scale
scaleLandscapeServices
workspaces-scaleLandscapeServices 1 param body → 200400401404
POST
/workspaces/{workspaceId}/pipeline/{stage}/start/{profile}
startPipelineStage
workspaces-startPipelineStage-1 3 params → 200400401404
POST
/workspaces/{workspaceId}/pipeline/{stage}/start
startPipelineStage
workspaces-startPipelineStage 2 params → 200400401404
POST
/workspaces/{workspaceId}/pipeline/{stage}/stop
stopPipelineStage
workspaces-stopPipelineStage 2 params → 200400401404
GET
/workspaces/{workspaceId}/pipeline/{stage}
pipelineStatus
workspaces-pipelineStatus 2 params → 200400401404
GET
/workspaces/{workspaceId}/env-vars
listEnvVars
workspaces-listEnvVars 1 param → 200400401404
PUT
/workspaces/{workspaceId}/env-vars
setEnvVar
workspaces-setEnvVar 1 param body → 200400401404
DELETE
/workspaces/{workspaceId}/env-vars
deleteEnvVar
workspaces-deleteEnvVar 1 param body → 200400401404
POST
/workspaces/{workspaceId}/execute
executeCommand
workspaces-executeCommand 1 param body → 200400401404
GET
/workspaces/{workspaceId}/git/head
gitHead
workspaces-gitHead 1 param → 200400401404
POST
/workspaces/{workspaceId}/git/pull/{remote}/{branch}
gitPull
workspaces-gitPull-2 3 params → 200400401404
POST
/workspaces/{workspaceId}/git/pull/{remote}
gitPull
workspaces-gitPull-1 2 params → 200400401404
POST
/workspaces/{workspaceId}/git/pull
gitPull
workspaces-gitPull 1 param → 200400401404
GET
/workspaces/{workspaceId}/logs/{stage}/{step}
logs
workspaces-logs 3 params → 200
GET
/workspaces/{workspaceId}/logs/run/{step}/server/{server}
serverLogs
workspaces-serverLogs 3 params → 200
GET
/workspaces/{workspaceId}/logs/run/{step}/replica/{replica}
replicaLogs
workspaces-replicaLogs 3 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are workspaces.logs.get.response (2 properties), workspaces.serverLogs.get.response (2 properties), _problem (2 properties), workspaces.replicaLogs.get.response (2 properties). Each schema is shown below with its type and property counts.

workspaces.replicaLogs.get.response
object
An SSE event of type data. Data contains a JSON object with given properties.
2 properties 2 required
_problem
object
An SSE event of type problem. Data contains a JSON object with given properties.
2 properties 2 required
workspaces.serverLogs.get.response
object
An SSE event of type data. Data contains a JSON object with given properties.
2 properties 2 required
workspaces.logs.get.response
object
An SSE event of type data. Data contains a JSON object with given properties.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

codesphere-workspaces-api-openapi.yml Raw ↑

Other APIs Codesphere publishes across the network.

Codesphere clusters API
Codesphere domains API
Codesphere managed-services API
Codesphere metadata API
Codesphere organizations API
Codesphere ssh API
Codesphere teams API
Codesphere usage API
Codesphere vault API
Where this information came from

This is an independent, third-party profile of Codesphere 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.