Get CI config

GET 
https://api.cloud.codenow.com/libraries/:libraryId/ci-config

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

Request

Path Parameters

libraryId 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

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.


release stringrequired


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

Example (from schema)

{
  "build": {
    "image": "string",
    "environmentVariables": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "pipelines": {
      "release": "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

curl -L 'https://api.cloud.codenow.com/libraries/:libraryId/ci-config' \
-H 'Accept: application/vnd.codenow.v1+json'

Request Collapse all

Base URL

https://api.cloud.codenow.com

Parameters

libraryId — pathrequired

branch — queryrequired

X-Codenow-Api-Key — headerrequired

ResponseClear

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