List branches

Beta

GET

/v1/branches

GET

/v1/branches

1 const url = 'http://127.0.0.1:8090/v1/branches';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "branches": [
3     {
4       "branch_id": "b7f3a9d2-4c1e-4f8a-9d3e-2a1b5c6d7e8f",
5       "database_id": "db12345",
6       "endpoint": "https://db12345.trace-db.com/branch/b7f3a9d2",
7       "latest_epoch": 1523,
8       "parent_branch_id": null,
9       "state": "active"
10     },
11     {
12       "branch_id": "c9d8e7f6-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
13       "database_id": "db12345",
14       "endpoint": "https://db12345.trace-db.com/branch/c9d8e7f6",
15       "latest_epoch": 1487,
16       "parent_branch_id": "b7f3a9d2-4c1e-4f8a-9d3e-2a1b5c6d7e8f",
17       "state": "archived"
18     }
19   ],
20   "gateway": true
21 }

Current TraceDB v1 product route. This OpenAPI artifact is generated from the checked-in route manifest.

Authentication

AuthorizationBearer

Required by gateway-managed routes; direct local engine development can use any token.

Response

Successful TraceDB response.

brancheslist of objectsOptional

gatewaybooleanOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

502

Bad Gateway Error

503

Service Unavailable Error