app get

Everything the platform knows about one application in a single object: where its image comes from, which ports it serves, the address it answers on, and how its last deployment ended.

This is the command to reach for when you want to confirm that a change landed. Environment variables are the one thing it will not show, in any format. Those belong to env list.

Usage

outplane app get [APP]

Arguments

Output

Examples

Show one application

outplane app get checkout

Show the app this directory is linked to

outplane app get

Read just the public address

outplane app get checkout --json --fields url

{
  "url": "https://checkout-3000-acme.outplane.app"
}

List every port the app serves

outplane app get checkout --json --fields endpoints

{
  "endpoints": [
    {
      "customDomains": [
        "checkout.example.com"
      ],
      "port": 3000,
      "public": true,
      "scheme": "http",
      "url": "https://checkout-3000-acme.outplane.app"
    }
  ]
}

What to Know

• Returns one object, not a list. app list returns {items, total, truncated}; this returns the fields directly.
• Environment variables are never included, in any format, and no flag adds them.
• url is the first address the app answers on: the platform address of the first public port, or a custom domain when no port is public. An app with several ports has one url and several endpoints, so read endpoints when the port matters.
• A name is resolved by listing the team's applications first, so this costs two requests. Passing the id skips nothing: the id is resolved the same way.
• repository and imageRef are mutually exclusive: a Git-sourced app has the first, a container-registry app has the second. Read source to know which to expect.
• status describes the last deployment, not a health check. An app can be ready and still be serving errors.
• A paused app reports status "paused" and keeps its own instances count. deploymentStatus says what it will return to.

Errors

Beyond 0 for success, this command exits with:

The code on the error object is one of app.not_found, app.ambiguous, context.no_app, usage.empty_argument, context.no_team. Branch on that, or on the exit status. The message is prose and changes.

Related