Viewport daemon, relay, and hosted runtime are available in alpha. Surfaces may change.
VIEWPORT
ReferenceAPI reference

Workspaces

57 operations in the Workspaces group.

53 of 57 operations on this page are generated contract stubs: the routes are real, the schemas are placeholders pending the owning subsystem's contract pass.

GET /api/workspaces

Operation ID: listWorkspaces

Responses

StatusDescriptionSchema
200Workspace collection.WorkspaceCollectionResponse

POST /api/workspaces

Operation ID: createWorkspace

Responses

StatusDescriptionSchema
201Created workspace.WorkspaceResponse

GET /api/workspaces/{workspace}

Operation ID: getWorkspace

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Workspace.WorkspaceResponse

PUT /api/workspaces/{workspace}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: putApiWorkspacesWorkspace

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PATCH /api/workspaces/{workspace}

Operation ID: updateWorkspace

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · WorkspaceUpdateRequest (required)

FieldTypeRequired
namestringno
description`stringnull`
labels`objectarray
policy_modeenum(open_access, allowlist, crypto_pairing)no
notification_policy`objectarray
budget_policy`objectarray
audit_retention_days`integernull`

Responses

StatusDescriptionSchema
200Updated workspace.WorkspaceResponse

DELETE /api/workspaces/{workspace}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkspacesWorkspace

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/audit

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceAudit

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/audit/export

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceAuditExport

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/crypto/epochs

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceCryptoEpochs

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/gitops/webhook/github

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceGitopsWebhookGithub

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/insights

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceInsights

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PATCH /api/workspaces/{workspace}/insights/{insight}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: patchApiWorkspacesWorkspaceInsightsInsight

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
insightpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/insights/{insight}/convert

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceInsightsInsightConvert

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
insightpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/insights/detect

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceInsightsDetect

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/insights/summary

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceInsightsSummary

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/installs

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceInstalls

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/installs

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceInstalls

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/installs/{install}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceInstallsInstall

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
installpathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/workspaces/{workspace}/installs/{install}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkspacesWorkspaceInstallsInstall

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
installpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/installs/{install}/heartbeat

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceInstallsInstallHeartbeat

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
installpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/invitations

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceInvitations

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/invitations

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceInvitations

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/workspaces/{workspace}/invitations/{invitation}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkspacesWorkspaceInvitationsInvitation

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
invitationpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PATCH /api/workspaces/{workspace}/members/{member}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: patchApiWorkspacesWorkspaceMembersMember

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
memberpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/workspaces/{workspace}/members/{member}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkspacesWorkspaceMembersMember

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
memberpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/members/transfer-owner

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceMembersTransferOwner

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/pairing-codes

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspacePairingCodes

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/relay-token

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceRelayToken

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/sync-sources

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceSyncSources

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/sync-sources

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceSyncSources

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/sync-sources/{source}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceSyncSourcesSource

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
sourcepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/workspaces/{workspace}/sync-sources/{source}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkspacesWorkspaceSyncSourcesSource

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
sourcepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/sync-sources/{source}/sync

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceSyncSourcesSourceSync

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
sourcepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/sync-sources/topology

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceSyncSourcesTopology

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/team-context

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceTeamContext

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PUT /api/workspaces/{workspace}/team-context

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: putApiWorkspacesWorkspaceTeamContext

Parameters

NameInRequiredTypeDescription
workspacepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/teams/{team}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceTeamsTeam

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PATCH /api/workspaces/{workspace}/teams/{team}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: patchApiWorkspacesWorkspaceTeamsTeam

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/workspaces/{workspace}/teams/{team}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkspacesWorkspaceTeamsTeam

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/teams/{team}/artifacts

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceTeamsTeamArtifacts

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/body

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceTeamsTeamArtifactsArtifactBody

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
artifactpathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PUT /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/body

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: putApiWorkspacesWorkspaceTeamsTeamArtifactsArtifactBody

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
artifactpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/body/unwrap-events

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceTeamsTeamArtifactsArtifactBodyUnwrapEvents

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
artifactpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/comments

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceTeamsTeamArtifactsArtifactComments

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
artifactpathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/comments

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceTeamsTeamArtifactsArtifactComments

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
artifactpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/comments/{comment}/unwrap-events

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceTeamsTeamArtifactsArtifactCommentsCommentUnwrapEvents

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
artifactpathyesstring
commentpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PATCH /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/review

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: patchApiWorkspacesWorkspaceTeamsTeamArtifactsArtifactReview

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
artifactpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/teams/{team}/members

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceTeamsTeamMembers

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PATCH /api/workspaces/{workspace}/teams/{team}/members/{member}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: patchApiWorkspacesWorkspaceTeamsTeamMembersMember

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
memberpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/workspaces/{workspace}/teams/{team}/members/{member}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkspacesWorkspaceTeamsTeamMembersMember

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
memberpathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/teams/{team}/resources

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceTeamsTeamResources

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/teams/{team}/resources

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceTeamsTeamResources

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PATCH /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: patchApiWorkspacesWorkspaceTeamsTeamResourcesTeamResource

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
teamResourcepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}/access-decision

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceTeamsTeamResourcesTeamResourceAccessDecision

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
teamResourcepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}/export

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceTeamsTeamResourcesTeamResourceExport

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
teamResourcepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}/export-bundle

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkspacesWorkspaceTeamsTeamResourcesTeamResourceExportBundle

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
teamResourcepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}/verify

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkspacesWorkspaceTeamsTeamResourcesTeamResourceVerify

Parameters

NameInRequiredTypeDescription
workspacepathyesstring
teampathyesstring
teamResourcepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

On this page

GET /api/workspacesPOST /api/workspacesGET /api/workspaces/{workspace}PUT /api/workspaces/{workspace}PATCH /api/workspaces/{workspace}DELETE /api/workspaces/{workspace}GET /api/workspaces/{workspace}/auditGET /api/workspaces/{workspace}/audit/exportGET /api/workspaces/{workspace}/crypto/epochsPOST /api/workspaces/{workspace}/gitops/webhook/githubGET /api/workspaces/{workspace}/insightsPATCH /api/workspaces/{workspace}/insights/{insight}POST /api/workspaces/{workspace}/insights/{insight}/convertPOST /api/workspaces/{workspace}/insights/detectGET /api/workspaces/{workspace}/insights/summaryGET /api/workspaces/{workspace}/installsPOST /api/workspaces/{workspace}/installsGET /api/workspaces/{workspace}/installs/{install}DELETE /api/workspaces/{workspace}/installs/{install}POST /api/workspaces/{workspace}/installs/{install}/heartbeatGET /api/workspaces/{workspace}/invitationsPOST /api/workspaces/{workspace}/invitationsDELETE /api/workspaces/{workspace}/invitations/{invitation}PATCH /api/workspaces/{workspace}/members/{member}DELETE /api/workspaces/{workspace}/members/{member}POST /api/workspaces/{workspace}/members/transfer-ownerPOST /api/workspaces/{workspace}/pairing-codesPOST /api/workspaces/{workspace}/relay-tokenGET /api/workspaces/{workspace}/sync-sourcesPOST /api/workspaces/{workspace}/sync-sourcesGET /api/workspaces/{workspace}/sync-sources/{source}DELETE /api/workspaces/{workspace}/sync-sources/{source}POST /api/workspaces/{workspace}/sync-sources/{source}/syncGET /api/workspaces/{workspace}/sync-sources/topologyGET /api/workspaces/{workspace}/team-contextPUT /api/workspaces/{workspace}/team-contextGET /api/workspaces/{workspace}/teams/{team}PATCH /api/workspaces/{workspace}/teams/{team}DELETE /api/workspaces/{workspace}/teams/{team}GET /api/workspaces/{workspace}/teams/{team}/artifactsGET /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/bodyPUT /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/bodyPOST /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/body/unwrap-eventsGET /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/commentsPOST /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/commentsPOST /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/comments/{comment}/unwrap-eventsPATCH /api/workspaces/{workspace}/teams/{team}/artifacts/{artifact}/reviewPOST /api/workspaces/{workspace}/teams/{team}/membersPATCH /api/workspaces/{workspace}/teams/{team}/members/{member}DELETE /api/workspaces/{workspace}/teams/{team}/members/{member}GET /api/workspaces/{workspace}/teams/{team}/resourcesPOST /api/workspaces/{workspace}/teams/{team}/resourcesPATCH /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}POST /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}/access-decisionPOST /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}/exportGET /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}/export-bundlePOST /api/workspaces/{workspace}/teams/{team}/resources/{teamResource}/verify