Product
Introducing Ruby Support in Socket
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
github.com/mattermost/focalboard/server
⚠️ Warning: The API is currently considered Beta and major changes are planned. Please see this note for more details.
This folder is generated by the make swagger
command from comments in the server code.
Prerequisites:
These can be installed via Homebrew:
brew tap go-swagger/go-swagger
brew install go-swagger
brew install openapi-generator
See the generated server API documentation here.
To auth against Personal Server, first call login with your credentials to get a token, e.g.
curl -X POST \
-H "Accept: application/json" \
-H "X-Requested-With: XMLHttpRequest" \
-H "Content-Type: application/json" \
"http://localhost:8000/api/v2/login" \
-d '{
"type" : "normal",
"username" : "testuser",
"password" : "testpass"
}'
This should return a token in the form:
{"token":"abcdefghijklmnopqrstuvwxyz1"}
Pass this as the bearer auth to subsequent calls, e.g.
curl -X GET \
-H "Accept: application/json" \
-H "Authorization: Bearer abcdefghijklmnopqrstuvwxyz1" \
-H "X-Requested-With: XMLHttpRequest" \
-H "Content-Type: application/json" \
"http://localhost:8000/api/v2/teams/0/boards"
The auto-generated Swagger API documentation is for Focalboard Personal Server. If you are calling the API on Mattermost Boards, the additional changes are:
The API endpoint is at https://SERVERNAME/plugins/focalboard/api/
, e.g. https://community.mattermost.com/plugins/focalboard/api/
.
Refer to the Mattermost API documentation here on how to obtain the auth token.
Pass this token as a bearer token to the Boards APIs, e.g.
curl -i -H "X-Requested-With: XMLHttpRequest" -H 'Authorization: Bearer abcdefghijklmnopqrstuvwxyz' https://community.mattermost.com/plugins/focalboard/api/v2/workspaces
Note that the X-Requested-With: XMLHttpRequest
header is required to pass the CSRF check.
If you are planning on using the Boards API, we would love to hear about what you'd like to do, and how we can improve the APIs in the future. See here for more details on how to connect.
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.