Facets

Facets UI Settings Controller API

The ui-settings-controller API from Facets — 4 operation(s) for ui-settings-controller.

GitHub OpenAPI

Operations 5

GET /cc-ui/v1/settings/entity/{entity} Get all settings for entity #
PUT /cc-ui/v1/settings/onboarding-display/{value} Set onboarding display #
GET /cc-ui/v1/settings/ui-yaml Get all settings yaml #
GET /cc-ui/v1/settings/value/{entityType}/{entityId} Get setting value #
PUT /cc-ui/v1/settings/value/{entityType}/{entityId} Add setting value #

Documentation

📖
Documentation
https://www.facets.cloud/docs
📖
APIReference
https://www.facets.cloud/docs/api
📖
GettingStarted
https://www.facets.cloud/docs/quickstart
📖
Authentication
https://www.facets.cloud/docs/api/recipes/authentication-setup

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/facets/refs/heads/main/openapi/facets-ui-settings-controller-api-openapi.yml

Other Resources

🔗
ReleaseNotes
https://www.facets.cloud/docs/changelog
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/facets/refs/heads/main/data-model/facets-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/facets/refs/heads/main/errors/facets-problem-types.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/facets/refs/heads/main/mcp/facets-tool-crosswalk.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/facets/refs/heads/main/asyncapi/facets-webhooks.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/facets-ui-settings-controller-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

facets-ui-settings-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: API Documentation
  title: Control-plane UI Settings Controller API
  version: '1.0'
servers:
- url: https://facetsdemo.console.facets.cloud
  description: Generated server url
security:
- basicAuth: []
tags:
- name: ui-settings-controller
paths:
  /cc-ui/v1/settings/entity/{entity}:
    get:
      operationId: getAllSettingsForEntity
      parameters:
      - in: path
        name: entity
        required: true
        schema:
          type: string
          enum:
          - CLUSTER
          - BLUE_PRINT
          - TEMPLATE_INPUT
          - CONTROL_PLANE
          - IAC
          - ARTIFACT_CI
          - USER_GROUP
          - ACCOUNT
          - ARTIFACTORY
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Setting'
          description: OK
        '400':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorDetails'
                - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                type: string
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Method Not Allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Conflict
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Internal Server Error
      tags:
      - ui-settings-controller
      summary: Get all settings for entity
      x-summary-source: derived
  /cc-ui/v1/settings/onboarding-display/{value}:
    put:
      operationId: setOnboardingDisplay
      parameters:
      - in: path
        name: value
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
        '400':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorDetails'
                - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                type: string
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Method Not Allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Conflict
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Internal Server Error
      tags:
      - ui-settings-controller
      summary: Set onboarding display
      x-summary-source: derived
  /cc-ui/v1/settings/ui-yaml:
    get:
      operationId: getAllSettingsYaml
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonNode'
          description: OK
        '400':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorDetails'
                - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                type: string
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Method Not Allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Conflict
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Internal Server Error
      tags:
      - ui-settings-controller
      summary: Get all settings yaml
      x-summary-source: derived
  /cc-ui/v1/settings/value/{entityType}/{entityId}:
    get:
      operationId: getSettingValue
      parameters:
      - in: path
        name: entityType
        required: true
        schema:
          type: string
          enum:
          - CLUSTER
          - BLUE_PRINT
          - TEMPLATE_INPUT
          - CONTROL_PLANE
          - IAC
          - ARTIFACT_CI
          - USER_GROUP
          - ACCOUNT
          - ARTIFACTORY
      - in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorDetails'
                - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                type: string
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Method Not Allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Conflict
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Internal Server Error
      tags:
      - ui-settings-controller
      summary: Get setting value
      x-summary-source: derived
    put:
      operationId: addSettingValue
      parameters:
      - in: path
        name: entityId
        required: true
        schema:
          type: string
      - in: path
        name: entityType
        required: true
        schema:
          type: string
          enum:
          - CLUSTER
          - BLUE_PRINT
          - TEMPLATE_INPUT
          - CONTROL_PLANE
          - IAC
          - ARTIFACT_CI
          - USER_GROUP
          - ACCOUNT
          - ARTIFACTORY
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorDetails'
                - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                type: string
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Method Not Allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Conflict
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
          description: Internal Server Error
      tags:
      - ui-settings-controller
      summary: Add setting value
      x-summary-source: derived
components:
  schemas:
    JsonNode:
      type: object
    ErrorDetails:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    GithubAppPermissionsPendingErrorDetails:
      type: object
      properties:
        approvalUrl:
          type: string
        code:
          type: string
        errorCode:
          type: string
        message:
          type: string
        missingPermissions:
          type: array
          items:
            type: string
    Setting:
      required:
      - defaultValue
      - entity
      - name
      - settingType
      - supportedForClouds
      type: object
      properties:
        allowedValues:
          type: array
          items:
            type: string
        createdBy:
          type: string
        creationDate:
          type: string
          format: date-time
        defaultValue:
          type: object
        description:
          type: string
        entity:
          type: string
          enum:
          - CLUSTER
          - BLUE_PRINT
          - TEMPLATE_INPUT
          - CONTROL_PLANE
          - IAC
          - ARTIFACT_CI
          - USER_GROUP
          - ACCOUNT
          - ARTIFACTORY
        id:
          type: string
        lastModifiedBy:
          type: string
        lastModifiedDate:
          type: string
          format: date-time
        max:
          type: integer
          format: int32
        min:
          type: integer
          format: int32
        name:
          type: string
        settingType:
          type: string
          enum:
          - NUMBER
          - STRING
          - ENUM
          - BOOLEAN
          - FLOAT
        supportedForClouds:
          type: array
          items:
            type: string
            enum:
            - AWS
            - AZURE
            - LOCAL
            - GCP
            - KUBERNETES
            - NO_CLOUD
  securitySchemes:
    basicAuth:
      description: Basic Authentication
      scheme: basic
      type: http