Get a CI config

GET 
https://api.cloud.codenow.com/applications/:applicationId/components/:componentId/ci-config

The operation allows you to retrieve details about a CI config of a specific application component and branch.

Request

Path Parameters

applicationId stringrequired

Possible values: non-empty

componentId stringrequired

Possible values: non-empty

Query Parameters

branch stringrequired

Possible values: non-empty

Header Parameters

X-Codenow-Api-Key anyrequired

CodeNOW API Key

Responses

200

CI config detail

application/vnd.codenow.v1+json

Schema

Schema

advancedMode

object

required


The field plays a crucial role in determining the build behavior within your CI pipelines.
When enabled, advanced mode empowers developers with greater control and flexibility over their build
processes by allowing them to utilize pre-existing Dockerfiles and Helm charts stored in their Git repositories.


enabled booleanrequired


A boolean flag indicating enablement of application component advanced mode.


build

object

required


The build section encompasses fields dedicated to configuring Continuous Integration (CI) pipelines themselves.
These settings allow users to define the environment variables, build container, and instance of pipeline necessary for building
artifacts seamlessly within their development workflows.


image stringrequired


The field specifies the container utilized for executing build
and unit test tasks within the Continuous Integration (CI) pipeline.


environmentVariables

object[]

required


The environmentVariables section configures custom environment variables
that are utilized within the Continuous Integration (CI) pipeline.


Array [

name stringrequired


The name of the environment variable.


value stringrequired


The value of the environment variable.


]

pipelines

object

required


The pipelines section defines and configures the specific pipelines
to be executed for release builds and preview builds.


preview stringrequired


Defines the pipeline id for performed preview builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.

release stringrequired


Defines the pipeline id for performed release builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.

runtime

object

required


The runtime section offers a range of fields that enable developers to customize the behavior of runtime artifacts created in CI pipelines.
These artifacts, such as Docker images or Helm charts, are essential components of the deployment process and directly influence the behavior of deployed applications.
The settings in the section is used only if the advancedMode is disabled.

image stringrequired


The base image the will be used for templating on-the-fly generated Dockerfile.


port stringrequired


The field specifies the port used by their application or process inside the container built during CI pipelines.
This port information is crucial for generating on-the-fly Helm charts, ensuring correct routing and networking configurations
when deploying applications to Kubernetes clusters.


endpoints

object

required


The endpoints section influences the exposure of components within a Kubernetes cluster.


external

object

required


The external section configures the behavior of exposing services outside the Kubernetes cluster.


enabled booleanrequired


The field determines whether a service will be exposed outside of the Kubernetes cluster.


java

object


The java section sets parameters for the Java process running inside the container that is result of CI pipeline.


jvmParameters stringrequired


The field sets up JVM (Java Virtual Machine) parameters for the Java process running inside the container that is result of CI pipeline.

Example (from schema)

{
  "advancedMode": {
    "enabled": true
  },
  "build": {
    "image": "string",
    "environmentVariables": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "pipelines": {
      "preview": "string",
      "release": "string"
    }
  },
  "runtime": {
    "image": "string",
    "port": "string",
    "endpoints": {
      "external": {
        "enabled": true
      }
    },
    "java": {
      "jvmParameters": "string"
    }
  }
}

400

The request was unacceptable, often due to missing a required parameter.

401

No valid API key provided.

403

The API key doesn't have permissions to perform the request.

404

Resource not found.

429

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500

Something went wrong on CodeNOW's end.

• curl
• nodejs
• csharp
• java

• CURL

Request Collapse all

Base URL

https://api.cloud.codenow.com

Parameters

applicationId — pathrequired

componentId — pathrequired

branch — queryrequired

X-Codenow-Api-Key — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!