Self-Hosted Runners

Get a workspace (self-hosted)

Retrieves details for a specific workspace by account and workspace ids (self-hosted)

get/self-hosted/{accountId}/workspaces/{workspaceId}

Request

Base URL
https://api.firefly.ai/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/firefly/apis/api-gateway/docs/self-hosted/:accountId/workspaces/:workspaceId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountIdstring required

Unique identifier of the account

workspaceIdstring required

Unique identifier of the workspace

Response

Workspace details retrieved successfully

idstring

Unique identifier for the workspace

namestring required

Name of the workspace

descriptionstring

Description of the workspace

accountIdstring

ID of the account the workspace belongs to

repositorystring required

Repository URL for the workspace

workingDirectorystring

Working directory within the repository

vcsIntegrationIdstring required

ID of the VCS integration

vcsstring required

VCS type (e.g., github, gitlab)

defaultBranchstring required

Default branch for the workspace

cronExecutionPatternstring

Cron pattern for scheduled executions

labelsstring[]

Labels assigned to the workspace

poolIdstring

ID of the runner pool associated with the workspace

oidcAuthenticationboolean nullable

OIDC authentication setting. If null, inherits from parent project.

isRemoteboolean

Whether this workspace uses the internal remote backend for state management

Example response

{
  "poolId": "123e4567-e89b-12d3-a456-426614174000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.