SAP API Management API Proxies API

openapi: 3.0.3
info:
  title: SAP API Management API Portal API Products API Proxies API
  description: 'The SAP API Management API Portal API provides RESTful endpoints built on OData principles for programmatically managing API proxies, API products, applications, developers, policies, and key-value maps within the SAP API Management platform. Authentication uses OAuth 2.0 with credentials from the service key generated for the API Portal Access Plan. The base URL is tenant-specific: https://{tenant-url}/apiportal/api/1.0/Management.svc.'
  version: '1.0'
  contact:
    name: SAP API Management Support
    url: https://help.sap.com/docs/sap-api-management
  license:
    name: SAP Terms
    url: https://www.sap.com/about/agreements/policies/cloud-platform.html
servers:
- url: https://{tenantUrl}/apiportal/api/1.0/Management.svc
  description: SAP API Management API Portal OData service
  variables:
    tenantUrl:
      description: Your SAP BTP tenant-specific URL
      default: your-tenant.cfapps.sap.hana.ondemand.com
security:
- OAuth2: []
tags:
- name: API Proxies
  description: Managed API proxies fronting backend services
paths:
  /APIProxies:
    get:
      operationId: listApiProxies
      summary: List API Proxies
      description: Retrieve all API proxies available in the SAP API Management platform. Supports OData query options for filtering and pagination.
      tags:
      - API Proxies
      parameters:
      - name: $filter
        in: query
        schema:
          type: string
      - name: $top
        in: query
        schema:
          type: integer
      - name: $skip
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: List of API proxies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIProxiesResponse'
    post:
      operationId: createApiProxy
      summary: Create API Proxy
      description: Create a new API proxy in the SAP API Management platform.
      tags:
      - API Proxies
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/APIProxyInput'
      responses:
        '201':
          description: API proxy created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIProxy'
  /APIProxies('{name}'):
    get:
      operationId: getApiProxy
      summary: Get API Proxy
      description: Retrieve a specific API proxy by name.
      tags:
      - API Proxies
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: API proxy details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIProxy'
    put:
      operationId: updateApiProxy
      summary: Update API Proxy
      description: Update an existing API proxy configuration.
      tags:
      - API Proxies
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/APIProxyInput'
      responses:
        '200':
          description: API proxy updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIProxy'
    delete:
      operationId: deleteApiProxy
      summary: Delete API Proxy
      description: Delete an API proxy from the platform.
      tags:
      - API Proxies
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: API proxy deleted
components:
  schemas:
    APIProxyInput:
      type: object
      required:
      - name
      - basepath
      properties:
        name:
          type: string
        title:
          type: string
        description:
          type: string
        version:
          type: string
        basepath:
          type: string
        apiProviderId:
          type: string
    APIProxy:
      type: object
      properties:
        name:
          type: string
          description: Unique API proxy name
        title:
          type: string
        description:
          type: string
        version:
          type: string
        basepath:
          type: string
          description: Base path for the API proxy
        status:
          type: string
          enum:
          - Active
          - Inactive
          - Draft
        apiProviderId:
          type: string
        createdAt:
          type: string
          format: date-time
        modifiedAt:
          type: string
          format: date-time
    APIProxiesResponse:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/APIProxy'
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 authentication using SAP BTP service key credentials
      flows:
        clientCredentials:
          tokenUrl: https://{tenantUrl}/oauth/token
          scopes:
            apiportal.access: Full access to API Management portal