---
title: "Update API Specification"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6/operations/update-api-spec"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6.md

# Update API Specification (deprecated)

`PATCH` `/apis/{apiId}/specifications/{specId}`

Operation ID: `update-api-spec`

Updates the specification (OpenAPI or AsyncAPI) of an API. **Note:** This endpoint is deprecated and will be removed: use /versions instead.

## Path parameters

- `apiId` (string, uuid, required) - The UUID API identifier
- `specId` (string, uuid, required) - The API specification identifier

## Request body (required)

Content types: `application/json`

## Responses

- `200` - API specification (OpenAPI or AsyncAPI)
- `400` - Bad Request
- `401` - ApiUnauthorized
- `403` - ApiForbidden
- `404` - Not Found
- `409` - Conflict - name attribute must be unique across specifications
- `415` - Unsupported Media Type

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Catalog
  version: 3.1.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /apis/{apiId}/specifications/{specId}:
    parameters:
      - $ref: "#/components/parameters/ApiId"
      - $ref: "#/components/parameters/SpecId"
    patch:
      operationId: update-api-spec
      summary: Update API Specification
      description: >
        Updates the specification (OpenAPI or AsyncAPI) of an API.

        **Note:** This endpoint is deprecated and will be removed: use /versions
        instead.
      requestBody:
        $ref: "#/components/requestBodies/UpdateApiSpecRequest"
      responses:
        "200":
          $ref: "#/components/responses/ApiSpecResponse"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                ApiSpecContentBadRequestExample:
                  $ref: "#/components/examples/ApiSpecContentBadRequestExample"
        "401":
          $ref: "#/components/responses/ApiUnauthorized"
        "403":
          $ref: "#/components/responses/ApiForbidden"
        "404":
          $ref: "#/components/responses/ApiNotFound"
        "409":
          $ref: "#/components/responses/ApiSpecHiddenConflict"
        "415":
          $ref: "#/components/responses/UnsupportedMediaType"
      deprecated: true
      tags:
        - API Specification
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    ApiId:
      schema:
        type: string
        format: uuid
        example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
      name: apiId
      in: path
      required: true
      description: The UUID API identifier
    SpecId:
      schema:
        type: string
        format: uuid
        example: d32d905a-ed33-46a3-a093-d8f536af9a8a
      name: specId
      description: The API specification identifier
      in: path
      required: true
  requestBodies:
    UpdateApiSpecRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApiSpec"
          examples:
            UpdateApiSpecContentRequest:
              $ref: "#/components/examples/UpdateApiSpecContentRequestExample"
            UpdateApiSpecContentRequestAsyncApi:
              $ref: "#/components/examples/UpdateApiSpecContentRequestExampleAsyncApi"
  responses:
    ApiSpecResponse:
      description: API specification (OpenAPI or AsyncAPI)
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                description: The API specification identifier.
                type: string
                format: uuid
                example: 7710d5c4-d902-410b-992f-18b814155b53
                readOnly: true
              content:
                description: >
                  The raw content of your API specification, in json or yaml
                  format (OpenAPI or AsyncAPI).
                example: '{"openapi":"3.0.3","info":{"title":"Example
                  API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example
                  endpoint","responses":{"200":{"description":"Successful
                  response"}}}}}}'
                type: string
              validation_messages:
                description: The errors that occurred while parsing the API specification.
                type: array
                items:
                  type: object
                  additionalProperties: false
                  required:
                    - message
                  properties:
                    message:
                      type: string
                readOnly: true
              type:
                description: >
                  The type of specification being stored. This allows us to
                  render the specification correctly.
                type: string
                example: oas3
                enum:
                  - oas2
                  - oas3
                  - asyncapi
                title: API Spec Type
              created_at:
                $ref: "#/components/schemas/CreatedAt"
              updated_at:
                $ref: "#/components/schemas/UpdatedAt"
            additionalProperties: false
            required:
              - id
              - content
              - type
              - created_at
              - updated_at
              - validation_messages
            title: API Specification
          examples:
            ApiSpecResponse:
              $ref: "#/components/examples/ApiSpecExample"
            ApiSpecResponseAsyncApi:
              $ref: "#/components/examples/ApiSpecExampleAsyncApi"
    ApiUnauthorized:
      description: ApiUnauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            ApiUnauthorizedExample:
              $ref: "#/components/examples/ApiUnauthorizedExample"
    ApiForbidden:
      description: ApiForbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            ApiForbiddenExample:
              $ref: "#/components/examples/ApiForbiddenExample"
    ApiNotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            ApiNotFoundExample:
              $ref: "#/components/examples/ApiNotFoundExample"
    ApiSpecHiddenConflict:
      description: Conflict - name attribute must be unique across specifications
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ConflictError"
          examples:
            ApiSpecConflictExample:
              $ref: "#/components/examples/ApiSpecHiddenConflictExample"
    UnsupportedMediaType:
      description: Unsupported Media Type
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnsupportedMediaTypeError"
          examples:
            UnsupportedMediaTypeExample:
              $ref: "#/components/examples/UnsupportedMediaTypeExample"
  schemas:
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    ApiSpec:
      type: object
      properties:
        id:
          description: The API specification identifier.
          type: string
          format: uuid
          example: 7710d5c4-d902-410b-992f-18b814155b53
          readOnly: true
        content:
          description: >
            The raw content of your API specification, in json or yaml format
            (OpenAPI or AsyncAPI).
          example: '{"openapi":"3.0.3","info":{"title":"Example
            API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example
            endpoint","responses":{"200":{"description":"Successful
            response"}}}}}}'
          type: string
        validation_messages:
          description: The errors that occurred while parsing the API specification.
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - message
            properties:
              message:
                type: string
          readOnly: true
        type:
          description: >
            The type of specification being stored. This allows us to render the
            specification correctly.
          type: string
          example: oas3
          enum:
            - oas2
            - oas3
            - asyncapi
          title: API Spec Type
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      title: API Specification
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    ConflictError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 409
            title:
              example: Conflict
            type:
              example: https://httpstatuses.com/409
            instance:
              example: kong:trace:1234567890
            detail:
              example: Conflict
    UnsupportedMediaTypeError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 415
            title:
              example: UnsupportedMediaType
            type:
              example: https://httpstatuses.com/415
            instance:
              example: kong:trace:1234567890
            detail:
              example: UnsupportedMediaType
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    ApiSpecContentBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: content
            rule: min_length
            minimum: 1
            reason: content must be longer than or equal to 1 characters
    UpdateApiSpecContentRequestExample:
      summary: Update API Spec Content (OAS3)
      value:
        content: '{"openapi":"3.0.3","info":{"title":"Example
          API","version":"1.0.1"},"paths":{"/example":{"get":{"summary":"Example
          endpoint","responses":{"200":{"description":"Successful
          response"}}}}}}'
    UpdateApiSpecContentRequestExampleAsyncApi:
      summary: Update API Spec Content (AsyncAPI)
      value:
        content: '{"asyncapi":"2.6.0","info":{"title":"Account Service
          Updated","version":"1.0.1","description":"This service is in charge of
          processing user signups
          (updated)"},"channels":{"user/signedup":{"publish":{"summary":"Inform
          about signed up
          users","operationId":"sendUserSignedUp","message":{"name":"UserSignedUp","payload":{"type":"object","properties":{"displayName":{"type":"string","description":"Name
          of the
          user"},"email":{"type":"string","format":"email","description":"Email
          of the user"}}}}}}}}'
        type: asyncapi
    ApiSpecExample:
      value:
        id: 7710d5c4-d902-410b-992f-18b814155b53
        content: '{"openapi":"3.0.3","info":{"title":"Example
          API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example
          endpoint","responses":{"200":{"description":"Successful
          response"}}}}}}'
        type: oas3
        validation_messages:
          - message: "'#/components/schemas/shouldExist' does not exist"
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    ApiSpecExampleAsyncApi:
      summary: API Spec Response (AsyncAPI)
      value:
        id: 8821e6d5-e013-411c-a03a-29c925266c64
        content: '{"asyncapi":"2.6.0","info":{"title":"Account
          Service","version":"1.0.0","description":"This service is in charge of
          processing user
          signups"},"channels":{"user/signedup":{"publish":{"summary":"Inform
          about signed up
          users","operationId":"sendUserSignedUp","message":{"name":"UserSignedUp","payload":{"type":"object","properties":{"displayName":{"type":"string","description":"Name
          of the
          user"},"email":{"type":"string","format":"email","description":"Email
          of the user"}}}}}}}}'
        type: asyncapi
        validation_messages: []
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    ApiUnauthorizedExample:
      value:
        status: 401
        title: ApiUnauthorized
        instance: kong:trace:8347343766220159418
        detail: ApiUnauthorized
    ApiForbiddenExample:
      value:
        status: 403
        title: ApiForbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    ApiNotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
    ApiSpecHiddenConflictExample:
      value:
        status: 409
        title: Conflict
        instance: kong:trace:9039922446017540182
        detail: Key (api_id, path)=(23380be0-c15e-4ca8-bcf7-43aadddc91b1, hidden.yaml)
          already exists.
    UnsupportedMediaTypeExample:
      value:
        status: 415
        title: Unsupported Media Type
        instance: kong:trace:8347343766220159418
        detail: "This API only supports requests with `Content-Type: application/json`"
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
