SAP Integration Suite Key Value Maps API

Manage key-value map configurations

OpenAPI Specification

sap-integration-suite-key-value-maps-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: SAP API Management API Products Key Value Maps API
  description: The SAP API Management API enables programmatic management of APIs, products, applications, and developer portals within SAP Integration Suite. It supports creating and publishing API proxies, managing rate plans, configuring policies, administering developer portals, and managing the full API lifecycle within SAP Business Technology Platform.
  version: 1.0.0
  contact:
    name: SAP Support
    url: https://support.sap.com
  license:
    name: SAP Developer License
    url: https://www.sap.com/about/agreements/product-use-and-support-terms.html
  x-logo:
    url: https://www.sap.com/dam/application/shared/logos/sap-logo.svg
servers:
- url: https://{api-portal-host}/apiportal/api/1.0
  description: SAP API Management API Portal
  variables:
    api-portal-host:
      default: my-tenant.apimanagement.sap.hana.ondemand.com
      description: SAP API Management host
security:
- oauth2: []
- basicAuth: []
tags:
- name: Key Value Maps
  description: Manage key-value map configurations
paths:
  /KeyValueMaps:
    get:
      operationId: listKeyValueMaps
      summary: List Key Value Maps
      description: Retrieve all key-value maps configured in the API Management tenant.
      tags:
      - Key Value Maps
      responses:
        '200':
          description: List of key-value maps
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/KeyValueMap'
        '401':
          description: Unauthorized
    post:
      operationId: createKeyValueMap
      summary: Create Key Value Map
      description: Create a new key-value map for storing configuration data.
      tags:
      - Key Value Maps
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyValueMap'
      responses:
        '201':
          description: Key-value map created
        '400':
          description: Bad request
components:
  schemas:
    KeyValueMap:
      type: object
      properties:
        name:
          type: string
          description: Key-value map name
        encrypted:
          type: boolean
          description: Whether values are stored encrypted
        scope:
          type: string
          description: Scope of the key-value map
          enum:
          - apiproxy
          - environment
          - organization
        keyValuePairs:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                description: Key name
              value:
                type: string
                description: Value (masked if encrypted)
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.authentication.sap.hana.ondemand.com/oauth/token
          scopes: {}
    basicAuth:
      type: http
      scheme: basic