Skip to content

Bandum API (runs on your machine): projects ​

Projects of the organization (key equal to the Tara project key, linked to a repo)

This page is generated from openapi.yaml by npm run gen, so do not edit it by hand. Authentication is described on the overview page.

GET/v1/projects

Projects of the organization (any role)

Server mode mirrors the organization's projects from Tara (refreshed at most every 60 seconds per organization): Tara is the single source of truth. Local mode lists the projects of the local organization.

Responses ​

CodeDescriptionType
200Projects in key orderapplication/json · object[]
401Not signed inapplication/problem+json · object
403Not allowed with this role, or the token or session has no organizationapplication/problem+json · object

Example response ​

json
[
  {
    "key": "shop-web",
    "name": "Shop Web",
    "repo": "acme/shop-web",
    "repos": [
      "string"
    ],
    "scmConnected": false
  }
]

Call with curl ​

bash
curl "http://localhost:8070/v1/projects" \
  -H "Authorization: Bearer $BANDUM_LOCAL_KEY"
PUT/v1/projects/{key}

Link a repo to a project (create it if needed; local mode only)

Server mode returns 403: projects are managed in Tara and Bandum mirrors them. Owner and Admin of the organization, or the project admin of key (Tara). The key is the Tara project key. Changing the repo deletes the copy of the old repo. Viewer and other Members get 403.

Parameters ​

NameInTypeRequiredDescription
keypathstringyesProject key (the Tara project key)

Body (application/json) ​

FieldTypeRequiredDescription
repostringyes

Responses ​

CodeDescriptionType
200Savedapplication/json · object
400Invalid parameterapplication/problem+json · object
401Not signed inapplication/problem+json · object
403Not allowed with this role, or the token or session has no organizationapplication/problem+json · object
409The repo is already linked to another project of this organizationapplication/problem+json · object

Example response ​

json
{
  "key": "shop-web",
  "name": "Shop Web",
  "repo": "acme/shop-web",
  "repos": [
    "string"
  ],
  "scmConnected": false
}

Call with curl ​

bash
curl -X PUT "http://localhost:8070/v1/projects/<key>" \
  -H "Authorization: Bearer $BANDUM_LOCAL_KEY" \
  -H "Content-Type: application/json" \
  -d '{"repo":"acme/shop-web"}'
DELETE/v1/projects/{key}

Delete a project and the copy of its repo (local mode only; server mode returns 403, projects are managed in Tara)

Parameters ​

NameInTypeRequiredDescription
keypathstringyesProject key (the Tara project key)

Responses ​

CodeDescriptionType
204Deleted
401Not signed inapplication/problem+json · object
403Not allowed with this role, or the token or session has no organizationapplication/problem+json · object
404Repo, milestone, task or organization not foundapplication/problem+json · object

Call with curl ​

bash
curl -X DELETE "http://localhost:8070/v1/projects/<key>" \
  -H "Authorization: Bearer $BANDUM_LOCAL_KEY"