Inductive Automation config-perspective-branding API

openapi: 3.0.3
info:
  title: Ignition Gateway REST access-control config-perspective-branding API
  description: The Ignition Gateway REST API (Ignition 8.3+) provides an OpenAPI-compliant HTTP interface to Gateway configuration resources including tags, projects, modules, device connections, historian data, user management (SCIM), alarm notification, OPC connections, and more. The specification is dynamically generated based on installed modules. Authentication uses API keys exchanged for time-limited tokens via the X-Ignition-API-Token header. Mutative requests are audit-logged. Supports Kubernetes and Helm-based cloud-native deployments.
  version: 8.3.0
  contact:
    name: Inductive Automation Support
    url: https://support.inductiveautomation.com/
  license:
    name: Commercial
    url: https://inductiveautomation.com/pricing/
  x-postman-collection: https://raw.githubusercontent.com/inductiveautomation/83-api/main/postman/8.3.postman_collection_v2.json
servers:
- url: http://{gateway-host}:{port}
  description: Ignition Gateway (HTTP)
  variables:
    gateway-host:
      default: localhost
      description: Hostname or IP address of the Ignition Gateway
    port:
      default: '8088'
      description: Gateway HTTP port (default 8088; HTTPS default 8043)
- url: https://{gateway-host}:{port}
  description: Ignition Gateway (HTTPS)
  variables:
    gateway-host:
      default: localhost
      description: Hostname or IP address of the Ignition Gateway
    port:
      default: '8043'
      description: Gateway HTTPS port
security:
- apiKeyAuth: []
tags:
- name: config-perspective-branding
  description: Perspective module branding configuration
paths:
  /data/api/v1/resources/ignition/cobranding:
    put:
      summary: Modify Brand Customization
      operationId: modify-brand-customization-put
      tags:
      - config-perspective-branding
      description: Modify one or more Brand Customization resources
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
            - signature: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                enabled: <boolean>
                backgroundColor: <string>
                textColor: <string>
                buttonColor: <string>
                buttonTextColor: <string>
                logo: <string>
                favicon: <string>
                appIcon: <string>
                logoType: <string>
                logoName: <string>
                faviconName: <string>
                appIconName: <string>
                faviconSize: <string>
                appIconSize: <string>
              backupConfig:
                enabled: <boolean>
                backgroundColor: <string>
                textColor: <string>
                buttonColor: <string>
                buttonTextColor: <string>
                logo: <string>
                favicon: <string>
                appIcon: <string>
                logoType: <string>
                logoName: <string>
                faviconName: <string>
                appIconName: <string>
                faviconSize: <string>
                appIconSize: <string>
            - signature: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                enabled: <boolean>
                backgroundColor: <string>
                textColor: <string>
                buttonColor: <string>
                buttonTextColor: <string>
                logo: <string>
                favicon: <string>
                appIcon: <string>
                logoType: <string>
                logoName: <string>
                faviconName: <string>
                appIconName: <string>
                faviconSize: <string>
                appIconSize: <string>
              backupConfig:
                enabled: <boolean>
                backgroundColor: <string>
                textColor: <string>
                buttonColor: <string>
                buttonTextColor: <string>
                logo: <string>
                favicon: <string>
                appIcon: <string>
                logoType: <string>
                logoName: <string>
                faviconName: <string>
                appIconName: <string>
                faviconSize: <string>
                appIconSize: <string>
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    post:
      summary: Create Brand Customization
      operationId: create-brand-customization-post
      tags:
      - config-perspective-branding
      description: Create the Brand Customization resource
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
            - collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                enabled: <boolean>
                backgroundColor: <string>
                textColor: <string>
                buttonColor: <string>
                buttonTextColor: <string>
                logo: <string>
                favicon: <string>
                appIcon: <string>
                logoType: <string>
                logoName: <string>
                faviconName: <string>
                appIconName: <string>
                faviconSize: <string>
                appIconSize: <string>
              backupConfig:
                enabled: <boolean>
                backgroundColor: <string>
                textColor: <string>
                buttonColor: <string>
                buttonTextColor: <string>
                logo: <string>
                favicon: <string>
                appIcon: <string>
                logoType: <string>
                logoName: <string>
                faviconName: <string>
                appIconName: <string>
                faviconSize: <string>
                appIconSize: <string>
            - collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                enabled: <boolean>
                backgroundColor: <string>
                textColor: <string>
                buttonColor: <string>
                buttonTextColor: <string>
                logo: <string>
                favicon: <string>
                appIcon: <string>
                logoType: <string>
                logoName: <string>
                faviconName: <string>
                appIconName: <string>
                faviconSize: <string>
                appIconSize: <string>
              backupConfig:
                enabled: <boolean>
                backgroundColor: <string>
                textColor: <string>
                buttonColor: <string>
                buttonTextColor: <string>
                logo: <string>
                favicon: <string>
                appIcon: <string>
                logoType: <string>
                logoName: <string>
                faviconName: <string>
                appIconName: <string>
                faviconSize: <string>
                appIconSize: <string>
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /data/api/v1/resources/ignition/cobranding/{signature}:
    delete:
      summary: Delete Brand Customization
      operationId: delete-brand-customization-delete
      tags:
      - config-perspective-branding
      description: Delete the Brand Customization resource.
      parameters:
      - name: signature
        in: path
        required: true
        schema:
          type: string
      - name: collection
        in: query
        required: false
        schema:
          type: string
        description: The configuration collection to delete the resource from
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /data/api/v1/resources/singleton/ignition/cobranding:
    get:
      summary: Get Brand Customization Config
      operationId: get-brand-customization-config-get
      tags:
      - config-perspective-branding
      description: Retrieve configuration details about the Brand Customization resource
      parameters:
      - name: defaultIfUndefined
        in: query
        required: false
        schema:
          type: string
        description: If true, return the default configuration if the resource is not defined. Otherwise, return 404. Default is false.
      - name: collection
        in: query
        required: false
        schema:
          type: string
        description: The configuration collection to read the resource from
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /data/api/v1/resources/type/ignition/cobranding:
    get:
      summary: Describe 'Brand Customization' Resource Type
      operationId: describe-'brand-customization'-resource-type-get
      tags:
      - config-perspective-branding
      description: Describe the Brand Customization resource type
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Ignition-API-Token
      description: Time-limited API token. Obtain by posting credentials to the token endpoint. See /data/api/v1/token for details.
externalDocs:
  description: Ignition 8.3 Gateway REST API Documentation
  url: https://www.docs.inductiveautomation.com/docs/8.3/platform/gateway/openapi