API OVERVIEW

Welcome to the Jenkins X API. You can use the Jenkins X API to read and write Kubernetes resource objects via a Jenkins X API endpoint.

Resource Categories

This is a high-level overview of the basic types of resources provide by the Jenkins X API and their primary functions.

Apps resources describe extensions to Jenkins X.

Pipelines & Environments resources describe the work being done by Jenkins X.

User Management resources describe the user management done by Jenkins X.


Resource Objects

Resource objects typically have 3 components:


Resource Operations

Most resources provide the following Operations:

Create

Create operations will create the resource in the storage backend. After a resource is create the system will apply the desired state.

Update

Updates come in 2 forms: Replace and Patch:

Read

Reads come in 3 forms: Get, List and Watch:

Delete

Delete will delete a resource. Depending on the specific resource, child objects may or may not be garbage collected by the server. See notes on specific resource objects for details.

Additional Operations

Resources may define additional operations specific to that resource type.