Pull Request#

Proposals to merge one branch into another within a deployment’s database. Merging itself is done in the Hosted web UI, not through this API.

List a database’s pull requests#

GET /api/v1/deployments/{owner}/{deployment}/pulls

Returns the pull requests for one database in {owner}/{deployment}, newest first.

Pull requests belong to a deployment but are scoped to a database within it, so database is required — a deployment can host several, and their pull requests are unrelated.

Merging is not part of this API. Merge a pull request in the Hosted web UI; state here reports the result.

Pages hold up to 20 pull requests and the size is not caller-controlled. Do not infer the end of the list from how many came back — a full page can still be the last one. meta.next_page_token is the only signal that there is more, and its absence is the only signal that there is not.

Parameters

Example request

curl -X GET 'https://hosted.doltdb.com/api/v1/deployments/{owner}/{deployment}/pulls?database=inventory' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Responses

Example response 200

{
  "data": [
    {
      "id": "42",
      "database": "inventory",
      "title": "Add supplier table",
      "description": "Adds the supplier table and backfills it.",
      "from_branch": "add-suppliers",
      "to_branch": "main",
      "state": "open",
      "creator": "acme-ops",
      "created_at": "2026-08-11T09:14:00Z",
      "comment_count": 2
    }
  ]
}

List a pull request’s comments#

GET /api/v1/deployments/{owner}/{deployment}/pulls/{id}/comments

Returns every comment on one pull request, oldest first.

The list is not paginated: a pull request reports its comments whole.

Parameters

Example request

curl -X GET 'https://hosted.doltdb.com/api/v1/deployments/{owner}/{deployment}/pulls/{id}/comments' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Responses

Example response 200

{
  "data": [
    {
      "id": "6f8f57c2-9a1e-4a3b-8f2d-1c4b5a6e7d80",
      "author": "acme-ops",
      "comment": "Backfill looks right to me.",
      "created_at": "2026-08-11T10:02:00Z",
      "updated_at": "2026-08-11T10:02:00Z"
    },
    {
      "id": "9d2c1b4a-7e6f-4c5d-9a8b-0f1e2d3c4b5a",
      "author": "acme-dev",
      "comment": "Can we add an index on supplier_id?",
      "created_at": "2026-08-11T11:20:00Z",
      "updated_at": "2026-08-11T11:24:00Z"
    }
  ]
}

Comment on a pull request#

POST /api/v1/deployments/{owner}/{deployment}/pulls/{id}/comments

Adds a comment to one pull request and returns the comment that was created.

Any token that can read the deployment can comment.

Parameters

Request body

Example request

curl -X POST 'https://hosted.doltdb.com/api/v1/deployments/{owner}/{deployment}/pulls/{id}/comments' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"comment":"Backfill looks right to me."}'

Responses

Example response 201

{
  "data": {
    "id": "6f8f57c2-9a1e-4a3b-8f2d-1c4b5a6e7d80",
    "author": "acme-ops",
    "comment": "Backfill looks right to me.",
    "created_at": "2026-08-11T10:02:00Z",
    "updated_at": "2026-08-11T10:02:00Z"
  }
}

List a pull request’s activity log#

GET /api/v1/deployments/{owner}/{deployment}/pulls/{id}/logs

Returns the record of what has happened to one pull request — opened, closed, merged, and the branch or database deletions that closed it — oldest first.

The list is not paginated: a pull request reports its activity whole.

An entry’s user is empty when the activity was recorded by Hosted rather than by a person.

Parameters

Example request

curl -X GET 'https://hosted.doltdb.com/api/v1/deployments/{owner}/{deployment}/pulls/{id}/logs' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Responses

Example response 200

{
  "data": [
    {
      "id": "4b8a1f2c-3d5e-4a6b-8c9d-0e1f2a3b4c5d",
      "activity": "opened",
      "user": "acme-ops",
      "logged_at": "2026-08-11T09:14:00Z"
    },
    {
      "id": "c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
      "activity": "merged",
      "user": "acme-admin",
      "logged_at": "2026-08-12T16:40:00Z"
    },
    {
      "id": "7e6d5c4b-3a2f-4e1d-9c8b-7a6f5e4d3c2b",
      "activity": "branch_deleted",
      "user": "acme-admin",
      "logged_at": "2026-08-12T16:40:01Z"
    }
  ]
}