Is there open API documentation for the dashboard?

translator_bot · June 23, 2024, 1:03am

Note:
This topic has been translated from a Chinese forum by GPT and might contain errors.

Original topic: dashboard 有开放的API资料吗

| username: caiyfc

I would like to learn about the APIs related to the dashboard. Do any of you have relevant information?

translator_bot · June 23, 2024, 1:03am

| username: xfworld | Original post link

Check the source code, there probably isn’t any documentation.

github.com

pingcap/tidb-dashboard/blob/master/pkg/config/config.go

// Copyright 2024 PingCAP, Inc. Licensed under Apache-2.0.

package config

import (
	"crypto/tls"
	"net/url"
	"strings"

	"go.etcd.io/etcd/pkg/transport"

	"github.com/pingcap/tidb-dashboard/pkg/utils/version"
)

const (
	defaultPublicPathPrefix = "/dashboard"

	UIPathPrefix      = "/dashboard/"
	APIPathPrefix     = "/dashboard/api/"
	SwaggerPathPrefix = "/dashboard/api/swagger/"

This file has been truncated. show original

translator_bot · June 23, 2024, 1:03am

| username: onlyacat | Original post link

I have done it before. Although it is not directly open, there is still documentation available, and it can be called.

You need to simulate a login to get the JWT token and then continue with the operation.

It looks something like this.

translator_bot · June 23, 2024, 1:03am

| username: system | Original post link

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.