Dependency-Track Config Property API

openapi: 3.2.0
info:
  title: Dependency Track Config Property API
  version: 1.0.0
  contact:
    name: The Dependency-Track Authors
    url: https://github.com/DependencyTrack/dependency-track
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged configProperty across 2 of this provider''s published API definitions: dependency-track-openapi-v1.yaml, dependency-track-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api
tags:
- name: configProperty
paths:
  /v1/configProperty:
    get:
      description: Requires permission SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_READ
      operationId: getConfigProperties
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConfigPropertyResponse'
          description: A list of all ConfigProperties for the specified groupName
        '401':
          description: Unauthorized
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      summary: Returns a list of all ConfigProperties for the specified groupName
      tags:
      - configProperty
    post:
      description: Requires permission SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_UPDATE
      operationId: updateConfigProperty_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfigPropertyRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigPropertyResponse'
          description: The updated config property
        '401':
          description: Unauthorized
        '404':
          description: The config property could not be found
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      summary: Updates a config property
      tags:
      - configProperty
    servers:
    - url: /api
  /v1/configProperty/aggregate:
    post:
      description: Requires permission SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_UPDATE
      operationId: updateConfigProperty
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateConfigPropertyRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                  anyOf:
                  - $ref: '#/components/schemas/ConfigPropertyResponse'
                  - type: string
          description: The updated config properties. Each array element is either a successfully updated `ConfigPropertyResponse`, or an error message string if the entry's property could not be found, is read-only, or its requested value is invalid.
        '401':
          description: Unauthorized
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      summary: Updates an array of config properties
      tags:
      - configProperty
    servers:
    - url: /api
  /v1/configProperty/internal/{groupName}/{propertyName}:
    get:
      description: 'Requires authentication, but no permission.

        Returns both internal and public properties'
      operationId: getInternalConfigProperty
      parameters:
      - description: The group name of the value to retrieve
        in: path
        name: groupName
        required: true
        schema:
          type: string
      - description: The property name of the value to retrieve
        in: path
        name: propertyName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigPropertyResponse'
          description: The internal config property
        '401':
          description: Unauthorized
        '403':
          description: Not an internal- or public-readable config property
        '404':
          description: The config property could not be found
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      summary: Returns an internal ConfigProperty
      tags:
      - configProperty
    servers:
    - url: /api
  /v1/configProperty/public/{groupName}/{propertyName}:
    get:
      description: ''
      operationId: getPublicConfigProperty
      parameters:
      - description: The group name of the value to retrieve
        in: path
        name: groupName
        required: true
        schema:
          type: string
      - description: The property name of the value to retrieve
        in: path
        name: propertyName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigPropertyResponse'
          description: Public ConfigProperty returned
        '403':
          description: This is not a public visible ConfigProperty
        '404':
          description: The config property could not be found
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      summary: Returns a public ConfigProperty
      tags:
      - configProperty
    servers:
    - url: /api
components:
  schemas:
    ConfigPropertyResponse:
      type: object
      properties:
        description:
          type: string
          description: Description of the property
        groupName:
          type: string
          description: Group the property belongs to
        propertyName:
          type: string
          description: Name of the property
        propertyType:
          type: string
          description: Type of the property
          enum:
          - BOOLEAN
          - INTEGER
          - NUMBER
          - STRING
          - TIMESTAMP
          - URL
          - UUID
        propertyValue:
          type: string
          description: Value of the property
      required:
      - groupName
      - propertyName
      - propertyType
    UpdateConfigPropertyRequest:
      type: object
      properties:
        groupName:
          type: string
          description: Group the property belongs to
          maxLength: 255
          minLength: 1
          pattern: \P{Cc}+
        propertyName:
          type: string
          description: Name of the property
          maxLength: 255
          minLength: 1
          pattern: \P{Cc}+
        propertyValue:
          type: string
          description: Value of the property
          pattern: \P{Cc}+
      required:
      - groupName
      - propertyName
  securitySchemes:
    ApiKeyAuth:
      description: Authentication via API key.
      in: header
      name: X-Api-Key
      type: apiKey
    BearerAuth:
      bearerFormat: Opaque
      description: 'Authentication via opaque server-issued session token.

        Tokens are obtained from `POST /api/v1/user/login` or

        `POST /api/v1/user/oidc/login`.'
      scheme: bearer
      type: http
x-refined-from:
- dependency-track-openapi-v1.yaml
- dependency-track-openapi.yml