Snyk Apps API

The Apps API from Snyk — 20 operation(s) for apps.

OpenAPI Specification

snyk-apps-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Snyk AccessRequests Apps API
  version: REST
servers:
- description: Snyk REST API
  url: https://api.snyk.io/rest
security:
- APIToken: []
- BearerAuth: []
tags:
- name: Apps
paths:
  /groups/{group_id}/apps/installs:
    get:
      description: 'Get a list of Snyk Apps installed for a Group


        #### Required permissions


        - `View Apps (group.app.read)`'
      operationId: getAppInstallsForGroup
      parameters:
      - description: Expand relationships.
        explode: false
        in: query
        name: expand
        schema:
          items:
            enum:
            - app
            type: string
          type: array
        style: form
      - description: Group ID
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AppInstallData'
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                required:
                - data
                - jsonapi
                - links
                type: object
          description: A list of apps installed for the specified group.
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Get a list of Snyk Apps installed for a Group
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-19~experimental
      - '2023-11-03'
      - '2024-05-23'
      x-snyk-api-resource: app_installs
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-05-23'
      x-stability-level: stable
    post:
      description: 'Install a Snyk App to this group, the Snyk App must use unattended authentication e.g. client credentials


        #### Required permissions


        - `Install Apps (group.app.install)`'
      operationId: createGroupAppInstall
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Group ID
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              additionalProperties: false
              properties:
                data:
                  properties:
                    type:
                      enum:
                      - app_install
                      example: app_install
                      type: string
                  type: object
                relationships:
                  additionalProperties: false
                  properties:
                    app:
                      additionalProperties: false
                      properties:
                        data:
                          additionalProperties: false
                          properties:
                            id:
                              $ref: '#/components/schemas/Uuid'
                            type:
                              enum:
                              - app
                              example: app
                              type: string
                          required:
                          - id
                          - type
                          type: object
                      required:
                      - data
                      type: object
                  required:
                  - app
                  type: object
              required:
              - data
              - relationships
              type: object
        description: App Install to be created
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    $ref: '#/components/schemas/AppInstallWithClient'
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                required:
                - data
                - jsonapi
                - links
                type: object
          description: The newly created app install.
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              schema:
                type: string
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Install a Snyk App for a Group
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-19~experimental
      - '2023-11-03'
      - '2024-05-23'
      x-snyk-api-resource: app_installs
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-05-23'
      x-stability-level: stable
  /groups/{group_id}/apps/installs/{install_id}:
    delete:
      description: 'Revoke app authorization for a Snyk group with install ID


        #### Required permissions


        - `Install Apps (group.app.install)`'
      operationId: deleteGroupAppInstallById
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Group ID
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/InstallId'
      responses:
        '204':
          description: The Snyk App install is revoked, with no content (no errors).
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              schema:
                type: string
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Revoke app authorization for a Snyk group with install ID
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-19~experimental
      - '2023-11-03'
      - '2024-05-23'
      x-snyk-api-resource: app_installs
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-05-23'
      x-stability-level: stable
  /groups/{group_id}/apps/installs/{install_id}/secrets:
    post:
      description: 'Manage client secret for non-interactive Snyk App installations


        #### Required permissions


        - `Edit Apps (group.app.edit)`'
      operationId: updateGroupAppInstallSecret
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Group ID
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/InstallId'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              additionalProperties: false
              properties:
                data:
                  additionalProperties: false
                  properties:
                    attributes:
                      additionalProperties: false
                      properties:
                        mode:
                          description: "Operation to perform:\n  * `replace` - Replace existing secrets with a new generated\nsecret\n  * `create` - Add a new secret, preserving existing secrets\n  * `delete` - Remove an existing secret by value\n"
                          enum:
                          - replace
                          - create
                          - delete
                          type: string
                        secret:
                          description: Secret to delete when using `delete` mode
                          type: string
                      required:
                      - mode
                      type: object
                    type:
                      enum:
                      - app
                      type: string
                  required:
                  - attributes
                  - type
                  type: object
              required:
              - data
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    $ref: '#/components/schemas/AppInstallDataWithSecret'
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/SelfLink'
                type: object
          description: Secret has been updated.
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              schema:
                type: string
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Manage client secret for non-interactive Snyk App installations
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-19~experimental
      - '2023-11-03'
      - '2024-05-23'
      x-snyk-api-resource: app_installs
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-05-23'
      x-stability-level: stable
  /orgs/{org_id}/app_bots:
    get:
      deprecated: true
      description: 'Get a list of app bots authorized to an organization. Deprecated, use /orgs/{org_id}/apps/installs instead.


        #### Required permissions


        - `View Apps (org.app.read)`'
      operationId: getAppBots
      parameters:
      - description: Expand relationships.
        explode: false
        in: query
        name: expand
        schema:
          items:
            enum:
            - app
            type: string
          type: array
        style: form
      - description: Organization ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AppBot'
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                required:
                - data
                - jsonapi
                - links
                type: object
          description: A list of app bots authorized to the specified organization
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Get a list of app bots authorized to an organization.
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - '2022-03-11'
      x-snyk-api-resource: app_bots
      x-snyk-api-stability: ga
      x-snyk-api-version: '2022-03-11'
      x-snyk-sunset-eligible: '2024-07-17'
      x-stability-level: stable
  /orgs/{org_id}/app_bots/{bot_id}:
    delete:
      deprecated: true
      description: 'Revoke app bot authorization. Deprecated, use /orgs/{org_id}/apps/installs/{install_id} instead.


        #### Required permissions


        - `Install Apps (org.app.install)`'
      operationId: deleteAppBot
      parameters:
      - description: The ID of the app bot
        in: path
        name: bot_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/Version'
      - description: Organization ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '204':
          description: The app bot has been deauthorized
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              schema:
                type: string
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Revoke app bot authorization
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - '2022-03-11'
      x-snyk-api-resource: app_bots
      x-snyk-api-stability: ga
      x-snyk-api-version: '2022-03-11'
      x-snyk-sunset-eligible: '2024-07-17'
      x-stability-level: stable
  /orgs/{org_id}/apps:
    get:
      deprecated: true
      description: 'Get a list of Snyk Apps created by an Organization Deprecated, use /orgs/{org_id}/apps/creations instead.


        #### Required permissions


        - `View Apps (org.app.read)`'
      operationId: getApps
      parameters:
      - $ref: '#/components/parameters/OrgId__0'
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AppData20220311'
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                required:
                - data
                - jsonapi
                - links
                type: object
          description: A list of apps created by the specified organization
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Get a list of Snyk Apps created by an Organization
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - '2022-03-11'
      x-snyk-api-resource: apps
      x-snyk-api-stability: ga
      x-snyk-api-version: '2022-03-11'
      x-snyk-sunset-eligible: '2024-07-17'
      x-stability-level: stable
    post:
      deprecated: true
      description: 'Create a new app for an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.


        #### Required permissions


        - `Create Apps (org.app.create)`'
      operationId: createApp
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/OrgId__0'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/AppPostRequest20220311'
        description: app to be created
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AppPostResponse20220311'
          description: Created Snyk App successfully
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              schema:
                type: string
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Create a new app for an organization.
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - '2022-03-11'
      x-snyk-api-resource: apps
      x-snyk-api-stability: ga
      x-snyk-api-version: '2022-03-11'
      x-snyk-sunset-eligible: '2024-07-17'
      x-stability-level: stable
  /orgs/{org_id}/apps/creations:
    get:
      description: 'Get a list of Snyk Apps created by an Organization


        #### Required permissions


        - `View Apps (org.app.read)`'
      operationId: getOrgApps
      parameters:
      - $ref: '#/components/parameters/OrgId__0'
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AppData'
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                required:
                - data
                - jsonapi
                - links
                type: object
          description: A list of apps created by the specified organization
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Get a list of Snyk Apps created by an Organization
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-19~experimental
      - '2023-11-03'
      x-snyk-api-resource: apps
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-11-03'
      x-stability-level: stable
    post:
      description: 'Create a new Snyk App for an organization


        #### Required permissions


        - `Create Apps (org.app.create)`'
      operationId: createOrgApp
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/OrgId__0'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/AppPostRequest'
        description: Snyk App details for app to be created.
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AppPostResponse'
          description: Created Snyk App successfully.
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              schema:
                type: string
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Create a new Snyk App for an organization
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-19~experimental
      - '2023-11-03'
      x-snyk-api-resource: apps
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-11-03'
      x-stability-level: stable
  /orgs/{org_id}/apps/creations/{app_id}:
    delete:
      description: 'Delete a Snyk App by app ID


        #### Required permissions


        - `Delete Apps (org.app.delete)`'
      operationId: deleteAppByID
      parameters:
      - $ref: '#/components/parameters/OrgId__0'
      - $ref: '#/components/parameters/AppId'
      - $ref: '#/components/parameters/Version'
      responses:
        '204':
          description: The app has been deleted
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              schema:
                type: string
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Delete a Snyk App by app ID
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-19~experimental
      - '2023-11-03'
      x-snyk-api-resource: apps
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-11-03'
      x-stability-level: stable
    get:
      description: 'Get a Snyk App by app ID


        #### Required permissions


        - `View Apps (org.app.read)`'
      operationId: getAppByID
      parameters:
      - $ref: '#/components/parameters/OrgId__0'
      - $ref: '#/components/parameters/AppId'
      - $ref: '#/components/parameters/Version'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    $ref: '#/components/schemas/AppData'
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/SelfLink'
                type: object
          description: Attributes of the requested Snyk App.
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400__0'
        '401':
          $ref: '#/components/responses/401__0'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404__0'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500__0'
      summary: Get a Snyk App by app ID
      tags:
      - Apps
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-19~experimental
      - '2023-11-03'
      x-snyk-api-resource: apps
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-11-03'
      x-stability-level: stable
    patch:
      description: 'Update app creation attributes with App ID


        #### Required permissions


        - `Edit Apps (org.app.edit)`'
      operationId: updateAppCreationByID
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/OrgId__0'
      - $ref: '#/components/parameters/AppId'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/AppPatchRequest'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    $ref: '#/components/schemas/AppData'
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/SelfLink'
                type: object
          description: Attributes of the updated Snyk App.
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/

# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-apps-api-openapi.yml