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

# Get a one-click app

> Returns a one-click app, including `spec`, a YAML document describing the apps it's made of and how to deploy them. No API token is needed.



## OpenAPI

````yaml /spec/paas-git-oneclick.yaml get /v1/one-click-apps/{oneClickAppName}
openapi: 3.0.1
info:
  title: Git Integration & One-Click Apps
  version: 1.0.0
  description: |
    Connect your GitHub account, link a repository to an app so it deploys
    automatically, and browse the one-click app catalog.

    ## Connecting GitHub

    Git integration has two parts:

    1. **Your GitHub account.** Connect it with
       `GET /v1/git-provider-integration/github` (sign in on GitHub) and
       `POST /v1/git-provider-integration/github`.
    2. **The Liara GitHub app,** installed on your GitHub account or
       organization to give access to repositories. Get the installation link
       with `GET /v1/git-repository-integration/github/connect`.

    Then link a repository to an app with
    `POST /v1/projects/{projectID}/git-repository-integration/github`. To see
    what's connected, use `GET /v1/me/git-integrations` (in Authentication &
    Account).

    `github` is currently the only supported `provider`. Git connections
    belong to you, not to a team. With `teamID`, the app-level endpoints use
    your own GitHub connection on the team's app.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: GitHub Account
    description: Connect and disconnect your GitHub account.
  - name: Repositories
    description: Install the GitHub app, and list repositories, branches and organizations.
  - name: App Repository
    description: Link a repository to an app and deploy from it.
  - name: One-Click Apps
    description: Browse ready-to-deploy apps.
paths:
  /v1/one-click-apps/{oneClickAppName}:
    get:
      tags:
        - One-Click Apps
      summary: Get a one-click app
      description: >-
        Returns a one-click app, including `spec`, a YAML document describing
        the apps it's made of and how to deploy them. No API token is needed.
      operationId: getOneClickApp
      parameters:
        - name: oneClickAppName
          in: path
          required: true
          schema:
            type: string
          example: ghost
      responses:
        '200':
          description: The one-click app.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  oneClickApp:
                    allOf:
                      - $ref: '#/components/schemas/OneClickAppSummary'
                      - type: object
                        properties:
                          spec:
                            type: string
                            description: >-
                              YAML describing the apps to deploy and their
                              settings.
                          githubOrg:
                            type: string
                            description: GitHub owner of the app's source.
                          githubRepo:
                            type: string
                            description: GitHub repository of the app's source.
                          updatedAt:
                            type: string
                            format: date-time
                  metadata:
                    type: object
                    description: Currently always empty.
              example:
                status: success
                oneClickApp:
                  _id: '000000000000000000000200'
                  name: ghost
                  about: Publishing platform
                  description: <description>
                  categories:
                    - CMS
                  numberOfInstall: 120
                  icon: https://example.com/ghost.png
                  mediaItems: []
                  spec: |-
                    apps:
                      - ...
                  createdAt: '2026-01-01T08:00:00.000Z'
                  updatedAt: '2026-01-01T08:00:00.000Z'
                metadata: {}
        '404':
          description: No one-click app with this name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 404
                error: Not Found
                message: Not Found
                data: null
      security: []
components:
  schemas:
    OneClickAppSummary:
      type: object
      properties:
        _id:
          type: string
        name:
          type: string
          description: >-
            The app's name; use it in `GET
            /v1/one-click-apps/{oneClickAppName}`.
        about:
          type: string
          description: Short summary.
        description:
          type: string
        categories:
          type: array
          items:
            type: string
        numberOfInstall:
          type: integer
          description: How many times it has been installed.
        icon:
          type: string
        mediaItems:
          type: array
          description: Screenshot URLs.
          items:
            type: string
        videoURL:
          type: string
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your API token as `Authorization: Bearer <api-token>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.