api_other4

Audit Log2

Authentication1

Backup and DR4

Codification6

Config1

Event Center1

Governance4

Guardrails4

IaC Stacks5

Infrastructure1

Integrations4

openId-connect_other2

Projects11

projectVariable_other4

Relationships1

Runners Workspaces11

Self-Hosted Runners30

self-hosted_other2

Terraform Remote Backend12

Terralist4

User Service5

Variable Set Operations4

Variable Sets8

VCS7

VCS Events1

Workspace State2

Workspaces8

workspaceVariable_other3

Projects

Get a project

Retrieves a single project by ID

get/runners/projects/{projectId}

Request

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

Path parameters

projectIdstring required

Unique identifier of the project to retrieve

Response

Project retrieved successfully

namestring

Name of the project

descriptionstring

Description of the project

labelsstring[]

Labels to assign to the project

poolIdstring uuid

UUID of the runner pool associated with the project

cronExecutionPatternstring

Cron pattern for scheduled executions

oidcAuthenticationboolean nullable

OIDC authentication setting.

idstring

Unique identifier for the project

accountIdstring

ID of the account the project belongs to

membersCountinteger

Number of members assigned to the project

workspaceCountinteger

Number of workspaces in the project

parentIdstring

ID of the parent project (for nested projects)

Example response

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

Changes

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