ChangelogService manages database migration history.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/bytebase:bytebase-changelogservice-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Bytebase API Reference Changelog Service API
description: API reference for Bytebase. Every endpoint is served by your own Bytebase instance.
version: 1.0.0
security: []
tags:
- name: ChangelogService
description: ChangelogService manages database migration history.
paths:
/v1/instances/{instance}/databases/{database}/changelogs:
get:
tags:
- ChangelogService
summary: ListChangelogs
description: 'Lists migration history for a database.
Permissions required: bb.changelogs.list'
operationId: ChangelogService_ListChangelogs
parameters:
- name: instance
in: path
description: The instance id.
required: true
schema:
type: string
- name: database
in: path
description: The database id.
required: true
schema:
type: string
- name: pageSize
in: query
description: "The maximum number of changelogs to return. The service may return fewer\n than this value. If unspecified, at most 10 changelogs will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000."
schema:
type: integer
title: page_size
format: int32
- name: pageToken
in: query
description: "A page token, received from the previous call.\n Provide this to retrieve the subsequent page.\n\n When paginating, all other parameters provided must match\n the call that provided the page token."
schema:
type: string
title: page_token
- name: view
in: query
description: The view query parameter.
schema:
allOf:
- $ref: '#/components/schemas/bytebase.v1.ChangelogView'
title: view
- name: filter
in: query
description: "Filter is used to filter changelogs returned in the list.\n The syntax and semantics of CEL are documented at https://github.com/google/cel-spec\n\n Supported filter:\n - status: the changelog status, support \"==\" operation. check Changelog.Status for available values.\n - has_schema_snapshot: filters to changelogs with a schema snapshot; only \"has_schema_snapshot == true\" is supported.\n - create_time: the changelog create time in RFC 3339 format, supports \">=\", \"<=\", or \"<\" operator.\n\n Example:\n status == \"DONE\"\n status == \"FAILED\"\n has_schema_snapshot == true && create_time < \"2024-01-02T00:00:00Z\""
schema:
type: string
title: filter
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/bytebase.v1.ListChangelogsResponse'
/v1/instances/{instance}/databases/{database}/changelogs/{changelog}:
get:
tags:
- ChangelogService
summary: GetChangelog
description: 'Retrieves a specific changelog entry.
Permissions required: bb.changelogs.get'
operationId: ChangelogService_GetChangelog
parameters:
- name: instance
in: path
description: The instance id.
required: true
schema:
type: string
- name: database
in: path
description: The database id.
required: true
schema:
type: string
- name: changelog
in: path
description: The changelog id.
required: true
schema:
type: string
- name: view
in: query
description: The view query parameter.
schema:
allOf:
- $ref: '#/components/schemas/bytebase.v1.ChangelogView'
title: view
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/bytebase.v1.Changelog'
/v1/projects/{project}/instances/{instance}/databases/{database}/changelogs:
get:
tags:
- ChangelogService
summary: ListChangelogs
description: 'Lists migration history for a database.
Permissions required: bb.changelogs.list'
operationId: ChangelogService_ListChangelogs2
parameters:
- name: project
in: path
description: The project id.
required: true
schema:
type: string
- name: instance
in: path
description: The instance id.
required: true
schema:
type: string
- name: database
in: path
description: The database id.
required: true
schema:
type: string
- name: pageSize
in: query
description: "The maximum number of changelogs to return. The service may return fewer\n than this value. If unspecified, at most 10 changelogs will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000."
schema:
type: integer
title: page_size
format: int32
- name: pageToken
in: query
description: "A page token, received from the previous call.\n Provide this to retrieve the subsequent page.\n\n When paginating, all other parameters provided must match\n the call that provided the page token."
schema:
type: string
title: page_token
- name: view
in: query
description: The view query parameter.
schema:
allOf:
- $ref: '#/components/schemas/bytebase.v1.ChangelogView'
title: view
- name: filter
in: query
description: "Filter is used to filter changelogs returned in the list.\n The syntax and semantics of CEL are documented at https://github.com/google/cel-spec\n\n Supported filter:\n - status: the changelog status, support \"==\" operation. check Changelog.Status for available values.\n - has_schema_snapshot: filters to changelogs with a schema snapshot; only \"has_schema_snapshot == true\" is supported.\n - create_time: the changelog create time in RFC 3339 format, supports \">=\", \"<=\", or \"<\" operator.\n\n Example:\n status == \"DONE\"\n status == \"FAILED\"\n has_schema_snapshot == true && create_time < \"2024-01-02T00:00:00Z\""
schema:
type: string
title: filter
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/bytebase.v1.ListChangelogsResponse'
/v1/projects/{project}/instances/{instance}/databases/{database}/changelogs/{changelog}:
get:
tags:
- ChangelogService
summary: GetChangelog
description: 'Retrieves a specific changelog entry.
Permissions required: bb.changelogs.get'
operationId: ChangelogService_GetChangelog2
parameters:
- name: project
in: path
description: The project id.
required: true
schema:
type: string
- name: instance
in: path
description: The instance id.
required: true
schema:
type: string
- name: database
in: path
description: The database id.
required: true
schema:
type: string
- name: changelog
in: path
description: The changelog id.
required: true
schema:
type: string
- name: view
in: query
description: The view query parameter.
schema:
allOf:
- $ref: '#/components/schemas/bytebase.v1.ChangelogView'
title: view
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/bytebase.v1.Changelog'
components:
schemas:
google.protobuf.Timestamp:
type: string
examples:
- '2023-01-15T01:30:15.01Z'
- '2024-12-25T12:00:00Z'
format: date-time
description: A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
bytebase.v1.Changelog.Status:
type: string
title: Status
enum:
- STATUS_UNSPECIFIED
- PENDING
- DONE
- FAILED
bytebase.v1.ChangelogView:
type: string
title: ChangelogView
enum:
- CHANGELOG_VIEW_UNSPECIFIED
- CHANGELOG_VIEW_BASIC
- CHANGELOG_VIEW_FULL
bytebase.v1.ListChangelogsResponse:
type: object
properties:
changelogs:
type: array
items:
$ref: '#/components/schemas/bytebase.v1.Changelog'
title: changelogs
description: The list of changelogs.
nextPageToken:
type: string
title: next_page_token
description: "A token, which can be sent as `page_token` to retrieve the next page.\n If this field is omitted, there are no subsequent pages."
title: ListChangelogsResponse
additionalProperties: false
bytebase.v1.Changelog:
type: object
properties:
name:
type: string
title: name
description: 'Format: instances/{instance}/databases/{database}/changelogs/{changelog} or projects/{project}/instances/{instance}/databases/{database}/changelogs/{changelog}'
createTime:
allOf:
- $ref: '#/components/schemas/google.protobuf.Timestamp'
title: create_time
status:
allOf:
- $ref: '#/components/schemas/bytebase.v1.Changelog.Status'
title: status
schema:
type: string
title: schema
schemaSize:
type: string
title: schema_size
format: int64
taskRun:
type: string
title: task_run
description: 'Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}'
planTitle:
type: string
title: plan_title
description: "The title of the plan associated with this changelog's task run.\n This field is populated by deriving the plan from task_run for display purposes."
readOnly: true
title: Changelog
additionalProperties: false
x-provenance:
method: harvested
publisher: Bytebase
source: https://api.bytebase.com/openapi.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)