Get application

Returns detailed information about an application including its current deployment status, configuration, events history, and endpoint URL.

GET /applications/{applicationName}

Get application

cURL

curl --request GET \
  --url https://api.blaxel.ai/v0/applications/{applicationName} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.blaxel.ai/v0/applications/{applicationName}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.blaxel.ai/v0/applications/{applicationName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blaxel.ai/v0/applications/{applicationName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blaxel.ai/v0/applications/{applicationName}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.blaxel.ai/v0/applications/{applicationName}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blaxel.ai/v0/applications/{applicationName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "metadata": {
    "name": "my-resource",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "My Resource",
    "externalId": "my-session-123",
    "labels": {},
    "plan": "<string>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "enabled": true,
    "port": 8080,
    "region": "us-pdx-1",
    "revision": {
      "active": "<string>",
      "canary": "<string>",
      "canaryPercent": 10,
      "stickySessionTtl": 0,
      "traffic": 100
    },
    "revisions": [
      {
        "image": "<string>",
        "createdAt": "<string>",
        "createdBy": "<string>",
        "envs": [
          {
            "name": "MY_ENV_VAR",
            "secret": true,
            "value": "my-value"
          }
        ],
        "id": "<string>",
        "memory": 2048,
        "port": 8080
      }
    ],
    "urls": [
      {
        "domain": "app.example.com",
        "subdomain": "www"
      }
    ]
  },
  "events": [
    {
      "canaryRevision": "<string>",
      "message": "Deployment successful",
      "revision": "rev-abc123",
      "status": "DEPLOYED",
      "time": "2025-01-15T10:30:00Z",
      "type": "deployment"
    }
  ],
  "status": "<string>"
}

{
  "error": "Resource already exists",
  "code": 409,
  "message": "Invalid request body"
}

{
  "error": "Resource already exists",
  "code": 409,
  "message": "Invalid request body"
}

{
  "error": "Resource already exists",
  "code": 409,
  "message": "Invalid request body"
}

{
  "error": "Resource already exists",
  "code": 409,
  "message": "Invalid request body"
}

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Path Parameters

applicationName · string · required

Unique name identifier of the application

Response

200

application/json

successful operation

Long-running application deployment that runs your custom code as a publicly accessible endpoint. Applications are always public and use mk3 generation.

metadata · object · required

Common metadata fields shared by all Blaxel resources including name, labels, timestamps, and ownership information

Show child attributes

spec · object · required

Configuration for an application including revision management, URL routing, and deployment region

Show child attributes

events · object[] · read-only

Events happening on a resource deployed on Blaxel

Show child attributes

status · string · read-only

Application status computed from events