Get application by ID

GET

/api/v1/applications/{id}

const url = 'http://localhost:3000/api/v1/applications/550e8400-e29b-41d4-a716-446655440000';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/applications/550e8400-e29b-41d4-a716-446655440000 \
  --header 'X-API-Key: <X-API-Key>'

Retrieves detailed information about a specific application including all versions.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Example

550e8400-e29b-41d4-a716-446655440000

Application package UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

Application retrieved successfully

application/json

object

data

required

Application package details with all versions

object

required

Unique identifier for the application package

string

organizationId

required

Organization that owns this application

string

name

required

Application name

string

description

Application description

string

descriptionMarkdown

Detailed markdown description of the application

string

releaseNotes

Release notes for the current version

string

descriptionFile

URL or path to detailed description file (Markdown)

string

releaseNotesFile

URL or path to release notes file (Markdown or PDF)

string

licenseFile

URL or path to license file (text, Markdown, or PDF)

string

licenseText

Inline license text content

string

vendor

Vendor/author name

string

category

Category classification

string

iconUrl

URL to application icon

string

availability

Application availability status

string

Allowed values: AVAILABLE SOURCE_UNAVAILABLE

metadata

required

Additional metadata

object

versionCount

required

Number of versions available

number

latestVersion

Latest version string

string

createdAt

required

When the package was created

string

updatedAt

required

When the package was last updated

string

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organizationId": "550e8400-e29b-41d4-a716-446655440002",
    "name": "Eclipse Mosquitto",
    "description": "Lightweight MQTT broker for IoT",
    "descriptionMarkdown": "# Mosquitto\n\nLightweight MQTT broker for IoT deployments.",
    "releaseNotes": "## Version 2.0.18\n\n- Security fixes\n- Performance improvements",
    "descriptionFile": "/api/v1/applications/550e8400.../files/description",
    "releaseNotesFile": "/api/v1/applications/550e8400.../files/release-notes",
    "licenseFile": "/api/v1/applications/550e8400.../files/license",
    "licenseText": "MIT License\n\nCopyright (c) 2024...",
    "vendor": "Eclipse Foundation",
    "category": "IoT",
    "iconUrl": "/api/v1/applications/550e8400.../icon",
    "availability": "AVAILABLE",
    "versionCount": 3,
    "latestVersion": "2.0.18",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

401

Unauthorized - Invalid or missing authentication

403

Forbidden — caller lacks required permission

404

Application not found