---
title: "Get Application by Portal"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37/operations/get-application"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37.md

# Get Application by Portal

`GET` `/portals/{portalId}/applications/{applicationId}`

Operation ID: `get-application`

Returns the configuration of a single application in this portal. If an application is linked to a DCR Provider, the `dcr_provider.id` and `reference_id` can be used to correlate it. An application manages a set of credentials and registrations for specific API product versions.

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.
- `applicationId` (string, uuid, required) - The application ID

## Responses

- `200` - Details about an application in a portal.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management
  version: 2.2.2
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
paths:
  /portals/{portalId}/applications/{applicationId}:
    get:
      operationId: get-application
      summary: Get Application by Portal
      description: Returns the configuration of a single application in this portal.
        If an application is linked to a DCR Provider, the `dcr_provider.id` and
        `reference_id` can be used to correlate it. An application manages a set
        of credentials and registrations for specific API product versions.
      parameters:
        - $ref: "#/components/parameters/PortalId"
        - $ref: "#/components/parameters/ApplicationId"
      responses:
        "200":
          $ref: "#/components/responses/GetApplication"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Portal Applications
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
    ApplicationId:
      name: applicationId
      in: path
      required: true
      description: The application ID
      schema:
        $ref: "#/components/schemas/UUID"
  responses:
    GetApplication:
      description: Details about an application in a portal.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/GetApplicationResponse"
          examples:
            Basic Application (No DCR with Identity Provider):
              $ref: "#/components/examples/GetApplicationExampleBasic"
            Using DCR with Identity Provider:
              $ref: "#/components/examples/GetApplicationExampleDcr"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    GetApplicationResponse:
      $ref: "#/components/schemas/Application"
    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
    Application:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        name:
          description: The unique (per developer) name of the application.
          type: string
        description:
          description: A description of the application.
          type: string
          nullable: true
        labels:
          $ref: "#/components/schemas/LabelsUpdate"
        reference_id:
          description: The ID used to linked the portal application to an Identity
            Provider application.
          type: string
          readOnly: true
        registration_count:
          description: The number of product version registrations that are associated
            with the application. Registrations of any status are included in
            the count.
          type: number
          readOnly: true
        dcr_provider:
          description: Information about the DCR provider this application uses, if using
            DCR.
          type: object
          additionalProperties: false
          nullable: true
          properties:
            id:
              $ref: "#/components/schemas/UUID"
          required:
            - id
        portal:
          description: Information about the portal the application is in.
          type: object
          additionalProperties: false
          properties:
            id:
              $ref: "#/components/schemas/UUID"
          required:
            - id
        developer:
          description: Information about the developer that owns the application.
          type: object
          additionalProperties: false
          properties:
            id:
              $ref: "#/components/schemas/UUID"
            name:
              description: The name of the developer that created the application.
              type: string
            email:
              description: The email of the developer that created the application.
              type: string
          required:
            - id
            - name
            - email
        auth_strategy:
          $ref: "#/components/schemas/AuthStrategy"
        granted_scopes:
          description: List of granted scopes for the application. Null if application
            type does not support returning granted scopes.
          type: array
          items:
            type: string
          nullable: true
      example:
        id: b15e2460-ba40-431d-9df0-4957fcffacda
        labels:
          env: test
        name: App 1
        description: An easy to manage app in a Konnect developer portal
        reference_id: df66b180-97df-4ddb-8b45-8b7d5eac56da
        registration_count: 4
        portal:
          id: 95606071-49c7-4c2e-ae49-8a86d72a8110
        dcr_provider: null
        granted_scopes: null
        developer:
          id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          name: Jane Dev
          email: jane.developer@example.com
        created_at: 2022-12-22T19:09:30.712Z
        updated_at: 2022-12-22T19:09:30.712Z
      additionalProperties: false
      required:
        - id
        - created_at
        - updated_at
        - name
        - description
        - reference_id
        - registration_count
        - dcr_provider
        - portal
        - developer
        - labels
        - granted_scopes
      title: Application
    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
    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
    LabelsUpdate:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Labels are intended to store **INTERNAL** metadata.


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
        nullable: true
      maxProperties: 50
      nullable: true
      writeOnly: true
    AuthStrategy:
      type: object
      discriminator:
        propertyName: credential_type
      oneOf:
        - $ref: "#/components/schemas/AuthStrategyKeyAuth"
        - $ref: "#/components/schemas/AuthStrategyClientCredentials"
    AuthStrategyKeyAuth:
      description: KeyAuth Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - key_auth
        key_names:
          type: array
          items:
            type: string
        ttl:
          description: Default maximum Time-To-Live for keys created under this strategy.
          type: object
          properties:
            value:
              type: integer
              minimum: 1
            unit:
              type: string
              enum:
                - days
                - weeks
                - years
          required:
            - value
            - unit
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - key_names
    AuthStrategyClientCredentials:
      description: Client Credential Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - client_credentials
            - self_managed_client_credentials
        auth_methods:
          $ref: "#/components/schemas/AuthMethods"
        available_scopes:
          $ref: "#/components/schemas/AvailableScopes"
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - auth_methods
    AuthMethods:
      type: array
      items:
        description: Auth Methods enabled for this strategy
        type: string
      example:
        - bearer
    AvailableScopes:
      description: Possible developer selectable scopes for an application. Only
        present when using DCR Provider that supports it.
      type: array
      items:
        type: string
      example:
        - scope1
        - scope2
  examples:
    GetApplicationExampleBasic:
      value:
        id: b15e2460-ba40-431d-9df0-4957fcffacda
        labels:
          env: test
        name: App 1
        description: An easy to manage app in a Konnect developer portal
        reference_id: df66b180-97df-4ddb-8b45-8b7d5eac56da
        registration_count: 4
        portal:
          id: 95606071-49c7-4c2e-ae49-8a86d72a8110
        dcr_provider: null
        granted_scopes: null
        developer:
          id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          name: Jane Dev
          email: jane.developer@example.com
        created_at: 2022-12-22T19:09:30.712Z
        updated_at: 2022-12-22T19:09:30.712Z
    GetApplicationExampleDcr:
      value:
        id: b15e2460-ba40-431d-9df0-4957fcffacda
        labels:
          env: test
        name: App 1
        description: A Konnect application that is linked to an Identity Provider
          application using Dynamic Client Registration (DCR)
        reference_id: yr1k0d9kj3l0cl01hp4o0
        registration_count: 1
        portal:
          id: 95606071-49c7-4c2e-ae49-8a86d72a8110
        dcr_provider:
          id: 7ea06071-49c7-4c2e-ae49-8a86d72a8110
        granted_scopes:
          - openid
        developer:
          id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          name: John Dev
          email: john.developer@example.com
        created_at: 2022-12-22T19:07:30.712Z
        updated_at: 2022-12-22T19:07:30.712Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    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...'`
```
