Backstage

Backstage Settings API

The Settings API from Backstage — 1 operation(s) for settings.

Documentation GitHub OpenAPI

Operations 2

GET /settings Get settings #

POST /settings Update settings #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/backstage-settings-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: notifications Settings API
  version: '1'
  description: The Backstage backend plugin that powers user notifications.
  license:
    name: Apache-2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  contact: {}
servers:
- url: /
tags:
- name: Settings
paths:
  /settings:
    get:
      operationId: GetSettings
      description: Get the current user's notification settings, merged with defaults.
      responses:
        '200':
          description: Effective notification settings for the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSettings'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - {}
      - JWT: []
      tags:
      - Settings
      summary: Get settings
      x-summary-source: derived
    post:
      operationId: UpdateSettings
      description: Update the current user's notification settings.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationSettings'
      responses:
        '200':
          description: Effective notification settings for the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSettings'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - {}
      - JWT: []
      tags:
      - Settings
      summary: Update settings
      x-summary-source: derived
components:
  schemas:
    OriginSetting:
      type: object
      required:
      - id
      - enabled
      properties:
        id:
          type: string
        enabled:
          type: boolean
        topics:
          type: array
          items:
            $ref: '#/components/schemas/TopicSetting'
    NotificationSettings:
      type: object
      required:
      - channels
      properties:
        channels:
          type: array
          items:
            $ref: '#/components/schemas/ChannelSetting'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            name:
              type: string
            message:
              type: string
          required:
          - name
          - message
        request:
          type: object
          properties:
            method:
              type: string
            url:
              type: string
          required:
          - method
          - url
        response:
          type: object
          properties:
            statusCode:
              type: number
          required:
          - statusCode
      required:
      - error
      - request
      - response
    ChannelSetting:
      type: object
      required:
      - id
      - origins
      properties:
        id:
          type: string
        enabled:
          type: boolean
        origins:
          type: array
          items:
            $ref: '#/components/schemas/OriginSetting'
    TopicSetting:
      type: object
      required:
      - id
      - enabled
      properties:
        id:
          type: string
        enabled:
          type: boolean
  responses:
    ErrorResponse:
      description: An error response from the backend.
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT