Get Branch Applications
List applications from a specific branch
Provides all the applications for the specified branch, regardless of the status, with optional filters.
Request
URI
GET
https://api.app-catalog.vmware.com/v1/applications/product/{product_id_or_key}/branch/{branch_id_or_key}
COPY
Path Parameters
product_id_or_key
Required
A string with either UUID format as the identifier of the requested product or its key.
string
branch_id_or_key
Required
Constraints:
maxLength: 100
A string with either UUID format as the identifier of the requested branch or its key
Query Parameters
string
distro
Optional
Constraints:
maxLength: 100
Distro ID or key to filter by
string
architecture
Optional
Constraints:
maxLength: 30
Processor architecture to filter by
boolean
only_built_versions
Optional
Constraints:
default: true
Parameter to query only for the applications that actually have a built version. If parameter is set to "false" then all related platforms without built version will appear under the same application, with empty version.
boolean
only_supported
Optional
Constraints:
default: false
Parameter to query only for supported items. A supported item is considered to have one of the following statuses: (ACTIVE,SCHEDULED_DEPRECATION,DEPRECATION_GRACE_PERIOD)
boolean
only_eligible
Optional
Constraints:
default: false
Parameter to query only for eligible items. An eligible item is considered to have one of the following statuses: (ACTIVE,SCHEDULED_DEPRECATION)
Responses
200
A list containing the applications
Returns
ApplicationBranch
of type(s)
application/json
This response body class contains all of the following:
InlineApplicationBranch0 ,
InlineApplicationBranch1
{
"product": {
"created_at": "2022-11-14T16:00:00.000Z",
"updated_at": "2022-11-14T16:00:00.000Z",
"applied_policy": {
"deprecation_policy": {
"key": "wordpress-6-deprecation",
"name": "Deprecation of Wordpress 6",
"deprecation_date": "2022-12-14T00:00:00.000Z",
"grace_period_days": 30,
"reason": "We will only maintain newest versions of Wordpress",
"alternative": "Wordpress 7 can be used instead",
"deprecation_policy_id": "49b8ee44-2945-4d93-8e87-a608399cfc3a"
},
"nonsupport_policy": {
"key": "memcached-nonsupport",
"name": "Memcached is not supported anymore",
"reason": "Upstream project has been discontinued.",
"nonsupport_policy_id": "49b8ee44-2945-4d93-8e87-a608399cfc3a"
}
},
"marked_draft": false
},
"branch": {
"latest_discovered_version": {
"version": "6.1",
"version_id": "22303119-5443-40b5-b95f-8914e7709ca5",
"license": {
"license_id": "99a07a3f-25fd-4dcb-9bf1-cdcb375033ca",
"name": "APACHE2"
},
"discovered_at": "2022-11-14T16:00:00.000Z"
}
},
"versions": [
{
"version": {
"version": "6.1",
"version_id": "22303119-5443-40b5-b95f-8914e7709ca5",
"license": {
"license_id": "99a07a3f-25fd-4dcb-9bf1-cdcb375033ca",
"name": "APACHE2"
},
"discovered_at": "2022-11-14T16:00:00.000Z"
},
"platforms": [
{
"created_at": "2022-11-14T16:00:00.000Z",
"updated_at": "2022-11-14T16:00:00.000Z",
"platform": {
"created_at": "2022-11-14T16:00:00.000Z",
"updated_at": "2022-11-14T16:00:00.000Z",
"distro": {
"key": "debian-11",
"os": "debian",
"version": "11",
"name": "Debian 11",
"fips_compliant": true,
"stig_compliant": true,
"os_family": "linux",
"public_offering": true,
"distro_id": "b1471ead-0a0e-4069-b8b5-59780b57d17f"
},
"applied_policy": {
"deprecation_policy": {
"key": "wordpress-6-deprecation",
"name": "Deprecation of Wordpress 6",
"deprecation_date": "2022-12-14T00:00:00.000Z",
"grace_period_days": 30,
"reason": "We will only maintain newest versions of Wordpress",
"alternative": "Wordpress 7 can be used instead",
"deprecation_policy_id": "49b8ee44-2945-4d93-8e87-a608399cfc3a"
},
"nonsupport_policy": {
"key": "memcached-nonsupport",
"name": "Memcached is not supported anymore",
"reason": "Upstream project has been discontinued.",
"nonsupport_policy_id": "49b8ee44-2945-4d93-8e87-a608399cfc3a"
}
},
"marked_draft": false
},
"status": "string",
"applied_policy": {
"deprecation_policy": {
"key": "wordpress-6-deprecation",
"name": "Deprecation of Wordpress 6",
"deprecation_date": "2022-12-14T00:00:00.000Z",
"grace_period_days": 30,
"reason": "We will only maintain newest versions of Wordpress",
"alternative": "Wordpress 7 can be used instead",
"deprecation_policy_id": "49b8ee44-2945-4d93-8e87-a608399cfc3a"
},
"nonsupport_policy": {
"key": "memcached-nonsupport",
"name": "Memcached is not supported anymore",
"reason": "Upstream project has been discontinued.",
"nonsupport_policy_id": "49b8ee44-2945-4d93-8e87-a608399cfc3a"
}
},
"testing_environments_features": [
"fips-compliant",
"arm64-compliant"
],
"latest_built_version": {
"version": "6.1",
"version_id": "22303119-5443-40b5-b95f-8914e7709ca5",
"license": {
"license_id": "99a07a3f-25fd-4dcb-9bf1-cdcb375033ca",
"name": "APACHE2"
},
"discovered_at": "2022-11-14T16:00:00.000Z"
},
"last_built_at": "2023-10-20T13:56:27.000Z"
}
]
}
]
}
400
Operation doesn't return any data structure
500
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v1/applications/product/{product_id_or_key}/branch/{branch_id_or_key}