> ## Documentation Index
> Fetch the complete documentation index at: https://tyk.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update description of an API

> Update description of an API including name, OAS URL and description



## OpenAPI

````yaml /swagger/5.12/enterprise-developer-portal-swagger.yaml put /products/{product_id}/api-details/{api-id}
openapi: 3.1.0
info:
  title: Tyk Developer Portal
  description: >-

    <img src="https://tyk.io/docs/img/developer_portal_swagger_image.png"
    width="963" height="250">

    ## <a name="introduction"></a> Introduction

    The Tyk Enterprise Developer Portal Management API offers programmatic
    access to all portal resources that your instance of the portal manages.
    This API repeats functionality of the user interface and enables APIs
    consumers integrating their portal instances with their other IT systems
    such as billings, CRMs, ITSM systems and other software.


    ## Authentication

    This API requires an admin authorisation token that is available for admin
    users of the portal in the profile page.
  version: 1.14.0
servers:
  - url: http://localhost:3001/portal-api
security: []
tags:
  - name: Providers
    description: API Providers connected to this portal instance
  - name: Users
    description: Portal admins and API consumers
  - name: Organisations
    description: Organisation of API consumers and the portal admins
  - name: Teams
    description: Teams of API consumers and the portal admins
  - name: Products
    description: >-
      Marketing description and visibility of the API Products surfaced in this
      portal instance
  - name: Tutorials for API Products
    description: Tutorials that are defined for the API products
  - name: API documentation for API Products
    description: OpenAPI specs for APIs included into the API Prodcuts
  - name: Plans
    description: >-
      Marketing description and visibility settings of usage plans defined in
      this portal instance
  - name: Catalogues
    description: Catalogues of API Products listed on this portal instance
  - name: Catalogue audiences
    description: Audience management
  - name: Access requests
    description: Access requests to API Products
  - name: Applications and credentials
    description: Developer applications and API credential for developers
  - name: Portal configuration
    description: Show the current portal configuration
  - name: Pages and content
    description: Pages and content on the pages
  - name: Themes
    description: Management of the portal's visual themes
  - name: Custom Attributes
    description: Extend already existing models (User) by adding custom attributes
  - name: OAuth2.0 providers
    description: OAuth2.0 providers registered in the portal
  - name: Webhooks
    description: Webhooks management
  - name: Posts
    description: Posts management
  - name: SSO Profiles
    description: SSO Profiles management
  - name: Tags
    description: >-
      Tags management: link API Products to blog posts and control their
      display.
paths:
  /products/{product_id}/api-details/{api-id}:
    put:
      tags:
        - API documentation for API Products
      summary: Update description of an API
      description: Update description of an API including name, OAS URL and description
      operationId: update-api-details
      parameters:
        - description: UID of an API as it comes from the API Provider
          in: path
          name: api-id
          required: true
          schema:
            type: string
            example: a0ce49d559ce49d64fe608ea3728082a
        - description: UID of an API Product
          in: path
          name: product_id
          required: true
          schema:
            type: integer
            example: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/APIDetail-update'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIDetail'
          description: OK
      security:
        - AdminAPIToken: []
components:
  schemas:
    APIDetail-update:
      properties:
        Description:
          type: string
          description: Human-readable description of an API added by the portal admins
          example: This API provides payment endpoints
        Name:
          type: string
          description: Name of an API as it is defined in the gateway
          example: Payment API
        OASUrl:
          type: string
          description: >-
            URL of OpenAPI Specification for this API. The document must be a
            valid OAS document
          example: https://petstore.swagger.io/v2/swagger.json
        Status:
          type: boolean
          description: >-
            Status of this API: `true` means the API is up and `false`
            identifies that it is down
          example: true
      type: object
    APIDetail:
      properties:
        APIType:
          type: string
          description: Authentication type of an API
          example: authToken
        Description:
          type: string
          description: Human-readable description of an API added by the portal admins
          example: This API provides payment endpoints
        ListenPath:
          type: string
          description: Listen path which is defined for this API in the gateway
          example: /payments/
        Name:
          type: string
          description: Name of an API as it is defined in the gateway
          example: Payment API
        OASUrl:
          type: string
          description: >-
            URL of OpenAPI Specification for this API. The document must be a
            valid OAS document
          example: https://petstore.swagger.io/v2/swagger.json
        Status:
          type: boolean
          description: >-
            Status of this API: `true` means the API is up and `false`
            identifies that it is down
          example: true
        TargetURL:
          type: string
          description: Upstream URL of this API
          example: http://httpbin.org/
      type: object
  securitySchemes:
    AdminAPIToken:
      type: apiKey
      in: header
      name: Authorization

````