Endpoints

This page explains the available API endpoints, including their parameters, responses, and examples. Use this information to integrate your applications with the CloudBees platform.

Retrieve a list of endpoints

Retrieve a list of environment endpoints or a specific environment endpoint based on the provided resourceId.

Endpoint

GET /v2/endpoints/list/{resourceId}

The following table outlines the parameters that can be used with this endpoint, including path and query parameters, their types, and if they are required or optional.

Parameter name In Type Required Description

Parameter name	In	Type	Required	Description
`resourceId`	Path	String	Yes	Specify the resource ID of the tenant, org, sub-org, component, or branch for which endpoints are requested.
`filter.search`	Query	String	No	Specify a string to filter the results.
`filter.resourceIds`	Query	Array[String]	No	Specify a list of resource IDs to filter the results.
`filter.contributionTypes`	Query	Array[String]	No	Specify a list of contribution types to filter the results.
`filter.contributionTargets`	Query	Array[String]	No	Specify a list of contribution targets to filter the results.
`filter.contributionIds`	Query	Array[String]	No	Specify a list of contribution IDs to filter the results.
`filter.includeDisabled`	Query	Boolean	No	Specify if disabled items are included in the response.
`pagination.page`	Query	Integer	No	Specify the page of results to return (default: 0 or 1).
`pagination.pageLength`	Query	Integer	No	Specify the number of items per page (default: API limit).
`pagination.sort.fieldName`	Query	String	No	Specify the field to sort by.
`pagination.sort.order`	Query	Enum(ascending or descending)	No	Specify the sort order (ascending or descending).
`pagination.lastPage`	Query	Boolean	No	Indicates if there are more results remaining (response-only).
`merged`	Query	Boolean	No	Specify if endpoint properties are merged with parent values.
`parents`	Query	Boolean	No	Specify if endpoints of the resource’s parents are included in the response.
`children`	Query	Boolean	No	Specify if endpoints of the resource’s descendants are included in the response.

resourceId

Path

String

Yes

Specify the resource ID of the tenant, org, sub-org, component, or branch for which endpoints are requested.

filter.search

Query

String

Specify a string to filter the results.

filter.resourceIds

Query

Array[String]

Specify a list of resource IDs to filter the results.

filter.contributionTypes

Query

Array[String]

Specify a list of contribution types to filter the results.

filter.contributionTargets

Query

Array[String]

Specify a list of contribution targets to filter the results.

filter.contributionIds

Query

Array[String]

Specify a list of contribution IDs to filter the results.

filter.includeDisabled

Query

Boolean

Specify if disabled items are included in the response.

pagination.page

Query

Integer

Specify the page of results to return (default: 0 or 1).

pagination.pageLength

Query

Integer

Specify the number of items per page (default: API limit).

pagination.sort.fieldName

Query

String

Specify the field to sort by.

pagination.sort.order

Query

Enum(ascending or descending)

Specify the sort order (ascending or descending).

pagination.lastPage

Query

Boolean

Indicates if there are more results remaining (response-only).

merged

Query

Boolean

Specify if endpoint properties are merged with parent values.

parents

Query

Boolean

Specify if endpoints of the resource’s parents are included in the response.

children

Query

Boolean

Specify if endpoints of the resource’s descendants are included in the response.

Responses

The following table describes the status codes returned by this endpoint, including their meanings and associated schemas.

Status Code Description Schema

Status Code	Description	Schema
200	OK. Successful response with a list of endpoints.	`api.endpoint.EndpointsResponse`
Default	Error response with details.	`google.rpc.Status`

200

OK. Successful response with a list of endpoints.

api.endpoint.EndpointsResponse

Default

Error response with details.

google.rpc.Status

Response example

{
  "endpoints": [
    {
      "id": "endpoint123",
      "name": "exampleEndpoint",
      "resourceId": "resource456",
      "description": "Example description",
      "contributionType": "typeA",
      "contributionTargets": ["targetA", "targetB"]
    }
  ],
  "pagination": {
    "page": 1,
    "pageLength": 10,
    "lastPage": true
  }
}▼