Apps

Retrieve application details and configuration for your Release apps.

Base URL: https://api.release.com

---

Get App

Retrieve details for a specific application.

Endpoint

GET /apps/{appId}

Authentication

Authenticate using headers from your ~/.release.yaml file. To set this up, install the Release CLI and run release auth login.

Header	Description
X-User-Email	User email from ~/.release.yaml (login field)
X-User-Token	User token from ~/.release.yaml (token field)

Headers

Header	Value	Required
Accept	application/json	Yes

Path Parameters

Parameter	Type	Required	Description
appId	string (hashid)	Yes	The unique identifier of the app

Status Codes

Status	Description
200	Successfully retrieved app
401	Unauthorized — invalid or missing authentication headers
404	App not found

Example Responses

200 OK

{
  "id": "def456",
  "name": "my-app",
  "account_id": "abc123",
  "repository": "github.com/org/repo"
}

---

Get App Config

Retrieve the latest application configuration YAML for a specific app.

Endpoint

GET /apps/{appId}/latest_config

Authentication

Authenticate using headers from your ~/.release.yaml file. To set this up, install the Release CLI and run release auth login.

Header	Description
X-User-Email	User email from ~/.release.yaml (login field)
X-User-Token	User token from ~/.release.yaml (token field)

Headers

Header	Value	Required
Accept	application/json	Yes

Path Parameters

Parameter	Type	Required	Description
appId	string (hashid)	Yes	The unique identifier of the app

Status Codes

Status	Description
200	Successfully retrieved app configuration
401	Unauthorized — invalid or missing authentication headers
404	App not found

Example Responses

200 OK

{
  "config": "--- \nservices:\n  backend:\n    image: org/backend\n    ports:\n      - 3000\n"
}