---
title: "Get an API Version"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-dev-3/versions/b2fc1681-05e8-4b55-9b8c-8bbcc7654d1b/operations/fetch-api-version"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-dev-3/versions/b2fc1681-05e8-4b55-9b8c-8bbcc7654d1b.md

# Get an API Version

`GET` `/apis/{apiId}/versions/{versionId}`

Operation ID: `fetch-api-version`

Fetches the version (OpenAPI or AsyncAPI) of an API.

## Path parameters

- `apiId` (string, uuid, required) - The UUID API identifier
- `versionId` (string, uuid, required) - The API version identifier

## Responses

- `200` - API version (OpenAPI or AsyncAPI)
- `401` - ApiUnauthorized
- `403` - ApiForbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Catalog
  version: 3.1.2
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}/versions/{versionId}:
    parameters:
      - $ref: "#/components/parameters/ApiId"
      - $ref: "#/components/parameters/VersionId"
    get:
      operationId: fetch-api-version
      summary: Get an API Version
      description: Fetches the version (OpenAPI or AsyncAPI) of an API.
      responses:
        "200":
          $ref: "#/components/responses/ApiVersionResponse"
        "401":
          $ref: "#/components/responses/ApiUnauthorized"
        "403":
          $ref: "#/components/responses/ApiForbidden"
        "404":
          $ref: "#/components/responses/ApiNotFound"
      tags:
        - API Version
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
    VersionId:
      schema:
        type: string
        format: uuid
        example: d32d905a-ed33-46a3-a093-d8f536af9a8a
      name: versionId
      description: The API version identifier
      in: path
      required: true
  responses:
    ApiVersionResponse:
      description: API version (OpenAPI or AsyncAPI)
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                description: The API version identifier.
                type: string
                format: uuid
                example: 7710d5c4-d902-410b-992f-18b814155b53
                readOnly: true
              version:
                description: The version of the api.
                type: string
                example: 1.0.0
              spec:
                type: object
                additionalProperties: false
                properties:
                  content:
                    description: >
                      The raw content of your API spec, 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
                  type:
                    description: >
                      The type of specification being stored. This allows us to
                      render the specification correctly.
                    type: string
                    example: oas3
                    enum:
                      - oas2
                      - oas3
                      - asyncapi
                    readOnly: true
                    title: API Spec Type
                  validation_messages:
                    description: The errors that occurred while parsing the API version spec.
                    type: array
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - message
                      properties:
                        message:
                          type: string
                    readOnly: true
                  provider:
                    description: >
                      The provider used to supply the spec content. In write
                      requests, provide

                      this instead of or alongside content. If omitted on
                      writes, the server

                      infers type raw from spec.content.
                    oneOf:
                      - $ref: "#/components/schemas/RawApiSpecProvider"
                      - $ref: "#/components/schemas/UrlApiSpecProvider"
                      - $ref: "#/components/schemas/IntegrationApiSpecProviderPayload"
                      - $ref: "#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"
                    title: ApiSpecProvider
              created_at:
                $ref: "#/components/schemas/CreatedAt"
              updated_at:
                $ref: "#/components/schemas/UpdatedAt"
            additionalProperties: false
            required:
              - id
              - version
              - created_at
              - updated_at
            title: API Version
          examples:
            ApiSpecResponse:
              $ref: "#/components/examples/ApiVersionExample"
            ApiSpecResponseAsyncApi:
              $ref: "#/components/examples/ApiVersionExampleAsyncApi"
    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"
  schemas:
    RawApiSpecProvider:
      type: object
      properties:
        type:
          type: string
          enum:
            - raw
        config:
          type: object
          additionalProperties: false
          maxProperties: 0
          minProperties: 0
      required:
        - type
        - config
    UrlApiSpecProvider:
      type: object
      properties:
        type:
          type: string
          enum:
            - url
        config:
          type: object
          properties:
            url:
              description: |
                Public URL that resolves to the raw API spec contents.
                Supported formats are JSON and YAML.
              type: string
              format: uri
              example: https://api.petstore.com/v3/openapi.json
          required:
            - url
      required:
        - type
        - config
    IntegrationApiSpecProviderPayload:
      description: >
        API spec provider registered by a catalog integration.


        Integrations can function as API spec providers where they register a
        globally unique

        `type` and config schema which defines the shape of `config`.


        Consult integration documentation to learn more about available API spec
        providers.
      type: object
      properties:
        type:
          description: The globally unique API spec provider type that is registered by a
            given catalog integration.
          type: string
          example: swaggerhub_api_version
          maxLength: 120
          minLength: 1
        config:
          description: JSON object containing values as defined by integration provider's
            config schema.
          type: object
          example:
            owner: petco
            api: pet_store
            version: v3
          additionalProperties: true
          minProperties: 1
        integration_instance:
          description: The integration instance id or name
          type: string
      required:
        - type
        - config
        - integration_instance
    ResourceBoundIntegrationApiSpecProviderPayload:
      description: >
        API spec provider registered by a catalog integration.


        These providers differ from `IntegrationApiSpecProvider` in that they

        denote a binding relationship between a resource type and the API spec.

        This means that the API Spec will automatically be created/deleted
        for/from a service

        as resources of the given type are mapped/unmapped.


        Consult integration documentation to learn more about available API spec
        providers.
      type: object
      properties:
        type:
          description: >
            The globally unique API spec provider type that is registered by a
            given catalog integration.

            Resource-bound providers create a 1-to-1 mapping between a resource
            type and the API Spec.
          type: string
          maxLength: 120
          minLength: 1
        config:
          type: object
          properties:
            resource_id:
              description: ID of the associated Resource the API spec is bound to.
              type: string
              example: IqkHvMdyHukxcwAs
          required:
            - resource_id
      required:
        - type
        - config
    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
    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
    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
  examples:
    ApiVersionExample:
      value:
        id: 7710d5c4-d902-410b-992f-18b814155b53
        version: 1.9.32
        spec:
          content: '{"openapi":"3.0.3","info":{"title":"Example
            API","version":"1.9.32"},"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
    ApiVersionExampleAsyncApi:
      summary: API Spec Response (AsyncAPI)
      value:
        id: 8821e6d5-e013-411c-a03a-29c925266c64
        version: 1.9.32
        spec:
          content: '{"asyncapi":"2.6.0","info":{"title":"Account
            Service","version":"1.9.32","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
  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...'`
```
