Applications

This page details the API endpoints available for integrating your applications with the CloudBees platform. It includes endpoint information, parameters, responses, and examples.

Retrieve a list of applications

Use this endpoint to retrieve all application-type services associated with a specific organization. This API is useful for discovering available applications within an organization, which can be linked to various environments.

Applications are returned by filtering services using the APPLICATION_FILTER type.

Endpoint

GET /v1/organizations/{organizationId}/services?typeFilter=APPLICATION_FILTER

Parameter name In Type Required? Description

Parameter name	In	Type	Required?	Description
`organizationId`	Path	String	Yes	The ID of the organization or sub-organization.
`typeFilter`	Query	String	Yes	Must be set to `APPLICATION_FILTER` to return only applications.

organizationId

Path

String

Yes

The ID of the organization or sub-organization.

typeFilter

Query

String

Yes

Must be set to APPLICATION_FILTER to return only applications.

Response

A successful response returns a list of application-type services, each with its metadata. The response uses the service key, which includes all application-type services.

Response example 1

{
  "service": [
    {
      "id": "12345678-123f-456g-789a-12345678abc",
      "name": "cbp",
      "description": "",
      "endpointId": "",
      "repositoryUrl": "",
      "defaultBranch": "",
      "organizationId": "87654321-321f-654g-987a-87654321cba",
      "serviceType": "APPLICATION",
      "linkedComponentIds": [],
      "linkedEnvironmentIds": [
        "12345678-092f-453d-a215-a12345678f83",
        "d3121234-492f-1234-8b92-c1234584cfdf"
      ]
    }
  ]
}▼

Response example 2

{
  "service": [
    {
      "id": "23456789-1234-876i-5678-23423456ghi",
      "name": "BeaconWeather",
      "description": "Weather app for mobile"
    },
    {
      "id": "345123450-567i-987j-4567-34678990hij",
      "name": "AnalyticsService"
    }
  ]
}▼

To view which environments are linked to each application, use the linkedEnvironmentIds field in the response from this API.