UNunkeyed
apps

Get app

Changed on

Retrieve a single app by its id or slug within a project.

Use this to fetch app details after creation or to verify an app exists before performing operations.

Required Permissions

Your root key must have one of the following permissions:

  • app.*.read_app (to read any app)
  • app.<app_id>.read_app (to read a specific app)
post/v2/apps.getApp

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/apps.getApp
  • Auth
    HTTP bearer

Request body

projectstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

appstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "project": "proj_1234abcd",
  "app": "proj_1234abcd"
}

Response

Successfully retrieved the app.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "app_1234abcd",
    "name": "Payments API",
    "slug": "payments-api",
    "sourceType": "oci",
    "git": {
      "repository": "unkeyed/unkey",
      "defaultBranch": "main"
    },
    "oci": {
      "image": "ghcr.io/acme/api:v1.2.3"
    },
    "currentDeploymentId": "d_1234abcd",
    "createdAt": 1704067200000,
    "updatedAt": 1704153600000
  }
}

Changes

  • 909d2961a72cRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 2dcddab7f374Revision changes
    • breaking

      removed the required property / from the response with the status

    • info

      added the optional property / to the response with the status