Apollo Config Apps API

Application management

OpenAPI Specification

apollo-config-apps-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Apollo Config Open Apps API
  description: Apollo Open API for configuration management including app management, namespace management, configuration publishing, and release management. Apollo provides centralized configuration management for distributed systems with real-time push, versioning, and gray release support.
  version: 2.2.0
  contact:
    name: Apollo Config
    url: https://www.apolloconfig.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8070
  description: Local Apollo Portal
- url: http://{portal_host}:{port}
  description: Custom Apollo Portal
  variables:
    portal_host:
      default: localhost
    port:
      default: '8070'
security:
- PortalToken: []
tags:
- name: Apps
  description: Application management
paths:
  /openapi/v1/apps:
    get:
      operationId: listApps
      summary: List all apps
      description: Returns a list of all registered applications.
      tags:
      - Apps
      responses:
        '200':
          description: List of applications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/App'
  /openapi/v1/apps/{appId}:
    get:
      operationId: getApp
      summary: Get app info
      description: Returns information about a specific application.
      tags:
      - Apps
      parameters:
      - $ref: '#/components/parameters/appId'
      responses:
        '200':
          description: Application info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '404':
          description: App not found
components:
  schemas:
    App:
      type: object
      properties:
        name:
          type: string
        appId:
          type: string
        orgId:
          type: string
        orgName:
          type: string
        ownerName:
          type: string
        ownerEmail:
          type: string
        dataChangeCreatedBy:
          type: string
        dataChangeLastModifiedBy:
          type: string
        dataChangeCreatedTime:
          type: string
          format: date-time
        dataChangeLastModifiedTime:
          type: string
          format: date-time
  parameters:
    appId:
      name: appId
      in: path
      required: true
      schema:
        type: string
      description: Application ID
  securitySchemes:
    PortalToken:
      type: apiKey
      name: Authorization
      in: header
      description: Apollo Portal open API token