Appfire

Appfire Restriction mode API

Read and set a tenant's OKR Restriction mode. Used by BigPicture's Security page; the M2M scope is the authorization and no user identity is exchanged.

Documentation GitHub OpenAPI

Operations 2

GET /api/internal/settings/restrictions Get the tenant's Restriction mode #

PUT /api/internal/settings/restrictions Set the tenant's Restriction mode #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/appfire/refs/heads/main/openapi/appfire-restriction-mode-api-openapi.yml

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/appfire:appfire-restriction-mode-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: OpenAPI definition Restriction mode API
  version: v0
  description: Read and set a tenant's OKR Restriction mode. Used by BigPicture's Security page; the M2M scope is the authorization and no user identity is exchanged.
servers:
- url: http://okr-ppm-prod.appfire.com
  description: Generated server url
tags:
- name: Restriction mode
  description: Read and set a tenant's OKR Restriction mode. Used by BigPicture's Security page; the M2M scope is the authorization and no user identity is exchanged.
paths:
  /api/internal/settings/restrictions:
    get:
      tags:
      - Restriction mode
      summary: Get the tenant's Restriction mode
      description: Projects the tenant's stored restriction settings onto a single mode. A tenant without stored settings reads as COMPLETELY_HIDDEN and the default record is created.
      operationId: getMode
      parameters:
      - name: X-APPFIRE-M2M-AUTH-INSTALLATION-ID
        in: header
        description: Forge installation ID of the tenant
        required: true
        schema:
          type: string
        example: ari:cloud:ecosystem::installation/2161e86b-06b8-4ea1-bec1-df6eed1dce91
      responses:
        '200':
          description: Current Restriction mode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictionModeBean'
        '400':
          description: Installation ID header missing, blank or not a Forge installation ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictionModeBean'
        '401':
          description: M2M token missing, invalid or lacking the OKR scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictionModeBean'
        '404':
          description: No tenant known for the installation ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictionModeBean'
    put:
      tags:
      - Restriction mode
      summary: Set the tenant's Restriction mode
      description: 'Idempotent: repeating the same mode changes nothing. Switching from an enabled mode to OFF irreversibly discards every restricted OKR''s configuration in the tenant; confirm with the user before sending OFF. OFF keeps the tenant''s last visibility choice so switching back on restores it.'
      operationId: setMode
      parameters:
      - name: X-APPFIRE-M2M-AUTH-INSTALLATION-ID
        in: header
        description: Forge installation ID of the tenant
        required: true
        schema:
          type: string
        example: ari:cloud:ecosystem::installation/2161e86b-06b8-4ea1-bec1-df6eed1dce91
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestrictionModeBean'
        required: true
      responses:
        '200':
          description: Persisted Restriction mode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictionModeBean'
        '400':
          description: Installation ID header missing, blank or not a Forge installation ID; body malformed; mode missing or unknown
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictionModeBean'
        '401':
          description: M2M token missing, invalid or lacking the OKR scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictionModeBean'
        '404':
          description: No tenant known for the installation ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictionModeBean'
components:
  schemas:
    RestrictionModeBean:
      type: object
      description: A tenant's Restriction mode
      properties:
        mode:
          type: string
          description: 'OFF: restrictions unavailable in the tenant. COMPLETELY_HIDDEN: users without permission do not see a restricted OKR at all. PARTIALLY_HIDDEN: they see its icon and progress only.'
          enum:
          - 'OFF'
          - COMPLETELY_HIDDEN
          - PARTIALLY_HIDDEN
      required:
      - mode
x-provenance:
  method: harvested
  publisher: Appfire
  source: https://okr-ppm-prod.appfire.com/v3/api-docs
  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)