openapi: 3.0.1
info:
title: CodeNOW API
description: Public CodeNOW API
version: application/vnd.codenow.v1+json
servers:
- url: https://api.cloud.codenow.com
paths:
/applications:
get:
tags:
- Applications
summary: List applications
description: |-
Lists applications. Returns a compact entry per application — related deployment targets are
intentionally omitted (fetch them per-application via
GET /applications/{applicationId}/deployment-targets). Labels are loaded only when
requested via expand=labels.
operationId: applications-list
parameters:
- name: expand
in: query
description: "Sub-resources to include on each entry. Supported: `labels`."
explode: false
schema:
type: array
nullable: true
items:
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: applications-list 200 response
content:
application/vnd.codenow.v2+json:
schema:
type: array
items:
$ref: "#/components/schemas/ApplicationListResponseV2"
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ApplicationResponse"
example: null
post:
tags:
- Applications
summary: Create an application
description: |-
Creates a new application. Related deployment targets are expressed as access policies on
`relatedEnvironments` and `relatedLabels` — each `{mode, ids}` where `mode` selects between
`ANY` (no constraint), `DENY_ALL` (none allowed) and `WHITELIST` (only listed ids allowed);
`ids` is meaningful only when `mode = WHITELIST`.
operationId: application-create
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
description: "Application name, optional description, and optional list of\
\ related environments."
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/ApplicationCreateRequestV2"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationCreateRequest"
examples:
create-application-v1:
summary: Create application 'my-app' related to env-prod
value:
name: my-app
description: Customer-facing storefront
relatedEnvironments:
- id: env-prod
production: true
example: null
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-create 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/ApplicationResponseV2"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationResponse"
example: null
/applications/{applicationId}:
get:
tags:
- Applications
summary: Get an application
description: |-
Gets an application detail. Optional related sub-resources are loaded only when requested via the
`expand` query parameter. Supported values: `deploymentTargets` (populates `deploymentTargets` —
the access policies and resolved items for related environments and labels), `labels` (populates
`resourceLabels`). When the parameter is omitted, only the base application fields are returned.
operationId: applications-get
parameters:
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: expand
in: query
description: "Sub-resources to include in the response. Supported: `deploymentTargets`,\
\ `labels`."
explode: false
schema:
type: array
nullable: true
items:
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: applications-get 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/ApplicationResponseV2"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationResponse"
example: null
put:
tags:
- Applications
summary: Update an application
description: |-
Updates specific settings for an application. If a setting is not specified, it will not be updated.
Related deployment targets are expressed as access policies on `relatedEnvironments` and
`relatedLabels` — each `{mode, ids}` where `mode` selects between `ANY` (no constraint),
`DENY_ALL` (none allowed) and `WHITELIST` (only listed ids allowed); `ids` is meaningful only
when `mode = WHITELIST`. Each policy is optional and, when present, replaces the existing policy
wholesale; omitted policies are left unchanged.
operationId: applications-update
parameters:
- name: applicationId
in: path
required: true
schema:
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
description: Fields to update. At least one of `description` or `relatedEnvironments`
must be set; omitted fields are left unchanged.
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/ApplicationUpdateRequestV2"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationUpdateRequest"
examples:
update-application-v1:
summary: Update description and related environments
value:
description: Customer-facing storefront (EU)
relatedEnvironments:
- id: env-prod
production: true
- id: env-staging
production: false
example: null
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: applications-update 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/OkResponse"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
example: null
delete:
tags:
- Applications
summary: Delete an application
description: "All resources associated with the application will be deleted,\
\ including its components"
operationId: applications-delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: applications-delete 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/components:
get:
tags:
- Application Components
summary: List application components
description: Lists components for the specified application.
operationId: application-components-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: allowedOps
in: query
required: false
explode: false
schema:
type: array
items:
type: string
default:
- detail
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-list 200 response
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ApplicationComponentResponse"
post:
tags:
- Application Components
summary: Create an application component
description: Creates a new component in the specified application.
operationId: application-components-create
parameters:
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/ApplicationComponentCreateRequestV2"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentCreateRequest"
example: null
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-create 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/ApplicationComponentCreateResponse"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentCreateResponse"
example: null
/applications/{applicationId}/components/{applicationComponentId}:
get:
tags:
- Application Components
summary: Get an application component
description: Gets a component detail for the specified application
operationId: application-components-get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-get 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentResponse"
put:
tags:
- Application Components
summary: Update an application component
description: "Updates specific settings for an application component. If a setting\
\ is not specified, it will not be updated."
operationId: application-components-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentUpdateRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-update 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
delete:
tags:
- Application Components
summary: Delete an application component
description: All resources associated with the component will be deleted
operationId: application-components-delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-delete 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/components/{applicationComponentId}/builds:
get:
tags:
- Application Component Builds
summary: List application component builds.
operationId: application-components-builds-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
type: string
- name: applicationComponentId
in: path
required: true
schema:
type: string
- name: page
in: query
required: false
explode: false
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: size
in: query
required: false
explode: false
schema:
minimum: 0
exclusiveMinimum: true
type: integer
format: int32
default: 10
responses:
"200":
description: Page of builds
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/Page_ApplicationComponentBuildResponse_"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
post:
tags:
- Application Component Builds
summary: Trigger an application component build.
operationId: application-components-builds-trigger
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
type: string
- name: applicationComponentId
in: path
required: true
schema:
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentBuildRequest"
required: true
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/applications/{applicationId}/components/{applicationComponentId}/builds/{id}:
get:
tags:
- Application Component Builds
summary: Get detail of an application component build.
operationId: application-components-builds-detail
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
type: string
- name: applicationComponentId
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: expand
in: query
explode: false
schema:
type: array
nullable: true
items:
$ref: "#/components/schemas/Expand_1"
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-builds-detail 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentBuildResponse"
/applications/{applicationId}/components/{applicationComponentId}/builds/{id}/cancel:
patch:
tags:
- Application Component Builds
summary: Cancel an application component build.
operationId: application-components-builds-cancel
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
type: string
- name: applicationComponentId
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/applications/{applicationId}/components/{applicationComponentId}/builds/{id}/labels/attach:
post:
tags:
- Application Component Builds
summary: Attach a label to an application component build
description: "Attaches a label to the build. If labelId is not provided, a new\
\ label will be created using text and color."
operationId: application-components-builds-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentBuildLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-builds-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/applications/{applicationId}/components/{applicationComponentId}/builds/{id}/labels/detach:
post:
tags:
- Application Component Builds
summary: Detach a label from an application component build
description: Detaches a label from the build.
operationId: application-components-builds-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentBuildLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-builds-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/components/{applicationComponentId}/builds/{id}/rerun:
post:
tags:
- Application Component Builds
summary: Rerun a failed application component build.
operationId: application-components-builds-rerun
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
type: string
- name: applicationComponentId
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/applications/{applicationId}/components/{applicationComponentId}/connections:
get:
tags:
- Application Component Connections
summary: Get application component connections
description: |-
Retrieves the configuration of connected services for given component.
Either (build) version or (git) branch must be provided as query parameter to specify the requested configuration version.
operationId: application-component-connections
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
- name: version
in: query
explode: false
schema:
type: string
nullable: true
- name: branch
in: query
explode: false
schema:
type: string
nullable: true
responses:
"422":
description: Unprocessable .codenow.config.yaml
"200":
description: 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentConnectionsConfigResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Application Component Connections
summary: Update application component connections
operationId: application-component-connections-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
- name: branch
in: query
required: true
explode: false
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ConnectionsUpdateRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-component-connections-update 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/components/{applicationComponentId}/labels/attach:
post:
tags:
- Application Components
summary: Attach a label to an application component
description: "Attaches a label to the application component. If labelId is not\
\ provided, a new label will be created using text and color."
operationId: application-components-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/applications/{applicationId}/components/{applicationComponentId}/labels/detach:
post:
tags:
- Application Components
summary: Detach a label from an application component
description: Detaches a label from the application component.
operationId: application-components-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-components-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/components/{applicationComponentId}/runtime-config:
get:
tags:
- Application Component Runtime Configurations
summary: Get application component runtime configuration
description: |-
Retrieves the runtime configuration detail for given component. Either (build) version or (git) branch must be provided as query parameter
to specify the requested runtime configuration version.
operationId: application-component-runtime-configuration-detail
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
- name: version
in: query
explode: false
schema:
type: string
nullable: true
- name: branch
in: query
explode: false
schema:
type: string
nullable: true
responses:
"422":
description: Unprocessable .codenow.config.yaml
"200":
description: 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentRuntimeConfigResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Application Component Runtime Configurations
summary: Update application component runtime configuration
operationId: application-component-runtime-configuration-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
- name: branch
in: query
required: true
explode: false
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/RuntimeConfig"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-component-runtime-configuration-update 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/components/{applicationComponentId}/triggers:
get:
tags:
- Application Component Triggers
summary: Get application component codenow triggers
operationId: application-component-triggers
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: Application component triggers response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/CodenowTriggersResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Application Component Triggers
summary: Update application component codenow triggers
operationId: application-component-triggers-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: applicationComponentId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/CodenowTriggersUpdateRequest"
required: true
responses:
"200":
description: Component triggers were updated
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/applications/{applicationId}/components/{componentId}/ci-config:
get:
tags:
- Application Component CI configurations
summary: Get a CI config
description: The operation allows you to retrieve details about a CI config
of a specific application component and branch.
operationId: application-components-ci-configs-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: componentId
in: path
required: true
schema:
minLength: 1
type: string
- name: branch
in: query
required: true
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: CI config detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentCiConfigResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Application Component CI configurations
summary: Update CI config
description: The operation allows you to update CI config of a specific application
component and branch.
operationId: application-components-ci-configs-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: componentId
in: path
required: true
schema:
minLength: 1
type: string
- name: branch
in: query
required: true
explode: false
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentCiConfigUpdateRequest"
required: true
responses:
"200":
description: CI config detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/applications/{applicationId}/components/{componentId}/ci-config/settings:
get:
tags:
- Application Component CI configurations
summary: Get CI config settings
description: The operation allows you to retrieve CI config settings.
operationId: application-components-ci-configs-settings-get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: componentId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: CI config settings
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentCiConfigSettingsResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Application Component CI configurations
summary: Update CI config settings
description: The operation allows you to update CI config settings.
operationId: application-components-ci-configs-settings-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: componentId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationComponentCiConfigSettingsUpdateRequest"
required: true
responses:
"200":
description: CI config settings updated
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/applications/{applicationId}/components/{componentId}/releases:
get:
tags:
- Application Component Releases
summary: Retrieve a list of application component releases.
operationId: application-component-releases-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: componentId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: List of application component releases
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ApplicationComponentRelease"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/applications/{applicationId}/deployment-configs:
get:
tags:
- Application Deployment Configurations
summary: List application deployment configurations
operationId: application-deployment-configs-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: includePreview
in: query
explode: false
schema:
type: boolean
default: false
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployment-configs-list 200 response
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ApplicationDeploymentConfigListItemResponse"
post:
tags:
- Application Deployment Configurations
summary: Create or update application deployment configuration
description: Create new application deployment configuration or update an existing
one.
operationId: application-deployment-config-store
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationDeploymentConfigStoreRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployment-config-store 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/deployment-configs/{version}:
get:
tags:
- Application Deployment Configurations
summary: Get application deployment configuration
description: "Get application deployment configuration detail. If no environment\
\ ID is specified, a default configuration will be returned."
operationId: application-deployment-config-detail
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: version
in: path
required: true
schema:
minLength: 1
type: string
- name: environmentId
in: query
explode: false
schema:
type: string
nullable: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployment-config-detail 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationDeploymentConfigResponse"
delete:
tags:
- Application Deployment Configurations
summary: Delete existing application deployment configuration
operationId: application-deployment-config-delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: version
in: path
required: true
schema:
minLength: 1
type: string
- name: environmentId
in: query
required: true
explode: false
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployment-config-delete 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/deployment-targets:
get:
tags:
- Applications
summary: Get related deployment targets for application
description: |-
Returns the composite related-deployment-targets view for the application — the access policy (`mode`)
and resolved `items` for both environments and labels. `mode = ANY` means no constraint; `DENY_ALL`
means no targets of that kind are allowed; `WHITELIST` means only the listed ids are allowed.
operationId: application-deployment-targets-get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployment-targets-get 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/RelatedDeploymentTargetsResponse"
/applications/{applicationId}/deployments:
get:
tags:
- Application Deployments
summary: List application deployments
operationId: application-deployments-list
parameters:
- name: expand
in: query
description: "Optional sub-resources to load on each entry. Supported: `pendingDeployments`,\
\ `jobRuns`, `routingRules`, `packageLabels`."
explode: false
schema:
type: array
nullable: true
items:
type: string
- name: applicationId
in: path
description: Application ID
required: true
schema:
minLength: 1
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployments-list 200 response
content:
application/vnd.codenow.v2+json:
schema:
type: array
items:
$ref: "#/components/schemas/ApplicationDeploymentResponseV2"
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ApplicationDeploymentResponse"
example: null
post:
tags:
- Application Deployments
summary: Deploy application to environment
operationId: application-deployment-create
parameters:
- name: applicationId
in: path
description: Application ID
required: true
schema:
minLength: 1
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
description: Deployment target environment and application package version
to deploy.
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/ApplicationDeploymentCreateRequestV2"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationDeploymentCreateRequest"
examples:
deploy-application-v1:
summary: Deploy version 1.4.0 to env-prod
value:
environmentId: env-prod
version: 1.4.0
example: null
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployment-create 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/JobQueueResponse"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
example: null
/applications/{applicationId}/deployments/{environmentId}:
get:
tags:
- Application Deployments
summary: Get application deployment detail
operationId: application-deployment-detail
parameters:
- name: environmentId
in: path
description: Target environment ID
required: true
schema:
minLength: 1
type: string
- name: expand
in: query
description: "Optional sub-resources to include in the response. Supported:\
\ `pendingDeployments`, `jobRuns`, `routingRules`, `packageLabels`."
explode: false
schema:
type: array
nullable: true
items:
type: string
- name: applicationId
in: path
description: Application ID
required: true
schema:
minLength: 1
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployment-detail 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/ApplicationDeploymentResponseV2"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationDeploymentResponse"
example: null
put:
tags:
- Application Deployments
summary: Sync application deployment
operationId: application-deployment-sync
parameters:
- name: environmentId
in: path
description: Target environment ID
required: true
schema:
minLength: 1
type: string
- name: applicationId
in: path
description: Application ID
required: true
schema:
minLength: 1
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployment-sync 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/OkResponse"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
example: null
delete:
tags:
- Application Deployments
summary: Undeploy application from environment
operationId: application-deployment-delete
parameters:
- name: environmentId
in: path
description: Target environment ID
required: true
schema:
minLength: 1
type: string
- name: applicationId
in: path
description: Application ID
required: true
schema:
minLength: 1
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-deployment-delete 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/OkResponse"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
example: null
/applications/{applicationId}/labels/attach:
post:
tags:
- Applications
summary: Attach a label to an application
description: "Attaches a label to the application. If labelId is not provided,\
\ a new label will be created using text and color."
operationId: application-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
description: Application ID
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/applications/{applicationId}/labels/detach:
post:
tags:
- Applications
summary: Detach a label from an application
description: Detaches a label from the application.
operationId: application-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
description: Application ID
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/packages:
get:
tags:
- Application Packages
summary: List application packages
operationId: application_packages-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: includeArchived
in: query
explode: false
schema:
type: boolean
default: false
- name: expand
in: query
explode: false
schema:
type: array
nullable: true
items:
$ref: "#/components/schemas/Expand"
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application_packages-list 200 response
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ApplicationPackageResponse"
post:
tags:
- Application Packages
summary: Create a new application package
operationId: application_packages-create
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationPackageCreateRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application_packages-create 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationPackageResponse"
/applications/{applicationId}/packages/{version}:
get:
tags:
- Application Packages
summary: Get detail of an application package
operationId: application_packages-detail
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: version
in: path
required: true
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application_packages-detail 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationPackageResponse"
delete:
tags:
- Application Packages
summary: Delete an application package
operationId: application_packages-delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: version
in: path
required: true
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application_packages-delete 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/packages/{version}/labels/attach:
post:
tags:
- Application Packages
summary: Attach a label to an application package
description: "Attaches a label to the application package. If labelId is not\
\ provided, a new label will be created using text and color."
operationId: application-packages-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
description: Application ID
required: true
schema:
minLength: 1
type: string
- name: version
in: path
description: Package version
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationBuildLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-packages-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/applications/{applicationId}/packages/{version}/labels/detach:
post:
tags:
- Application Packages
summary: Detach a label from an application package
description: Detaches a label from the application package.
operationId: application-packages-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: applicationId
in: path
description: Application ID
required: true
schema:
minLength: 1
type: string
- name: version
in: path
description: Package version
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ApplicationBuildLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-packages-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/applications/{applicationId}/related-environments:
get:
tags:
- Applications
summary: List effective deployment environments for application
description: |-
Returns the effective set of deployment environments for the application — environments matched by
the direct environment policy and, when `expand=labelEnvironments`, additionally those resolved from
the application's label policy. Each item carries a `source` marker (DIRECT or LABEL); direct entries
shadow label-resolved entries with the same id.
Supported `expand` values:
status — resolve each environment's status against its cluster (extra read);
labelEnvironments — also resolve and merge environments from the application's label policy.
To update the underlying access policies, use PUT /applications/{applicationId}.
operationId: application-related-environments-list
parameters:
- name: applicationId
in: path
required: true
schema:
minLength: 1
type: string
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: expand
in: query
description: "Optional expands. Supported: `status`, `labelEnvironments`."
explode: false
schema:
type: array
nullable: true
items:
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: application-related-environments-list 200 response
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/DeploymentEnvironmentsResponse"
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/Environment"
example: null
/ci-pipelines:
get:
tags:
- CI pipelines
summary: List CI pipelines
description: Lists CI pipelines.
operationId: ci-pipelines-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: defaultPipelineType
in: query
required: true
explode: false
schema:
$ref: "#/components/schemas/DefaultPipelineType"
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: ci-pipelines-list 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/PipelinesResponse"
/ci/components/{componentId}/ci:
get:
tags:
- CI Component Support API
summary: Get CodeNOW YAML for the component
operationId: ci-components-codenow-yaml
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: componentId
in: path
required: true
schema:
type: string
- name: branch
in: query
required: true
explode: false
schema:
type: string
responses:
"200":
description: CodeNOW YAML downloaded successfully
content:
application/vnd.codenow.v1+text:
schema:
type: object
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/ci/components/{componentId}/ci/dockerfile:
get:
tags:
- CI Component Support API
summary: Get Dockerfile for the component
operationId: ci-components-dockerfile
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: componentId
in: path
required: true
schema:
type: string
- name: branch
in: query
required: true
explode: false
schema:
type: string
responses:
"200":
description: Dockerfile downloaded successfully
content:
application/vnd.codenow.v1+text:
schema:
type: object
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/ci/components/{componentId}/ci/env:
get:
tags:
- CI Component Support API
summary: Get build environment variables for the component
operationId: ci-components-environment-variables-yaml
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: componentId
in: path
required: true
schema:
type: string
- name: branch
in: query
required: true
explode: false
schema:
type: string
- name: correlationId
in: query
required: true
explode: false
schema:
type: string
responses:
"200":
description: Environment build variables downloaded successfully
content:
application/vnd.codenow.v1+text:
schema:
type: object
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/ci/components/{componentId}/cicd:
get:
tags:
- CI Component Support API
summary: Download helm chart for the component as zip archive
operationId: ci-components-helm-chart
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: componentId
in: path
required: true
schema:
type: string
- name: branch
in: query
required: true
explode: false
schema:
type: string
responses:
"200":
description: Helm chart downloaded successfully
content:
application/vnd.codenow.v1+octet-stream:
schema:
type: object
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/ci/webhook:
post:
tags:
- CI Webhooks
summary: Webhook receiver for External CI Events
description: |
External CI communication endpoint, provides a way to send CI events to CodeNow.
Supported events:
Start event: indicates the start of a pipeline run. (once per run).
Result event: event with a payload with results of the pipeline run (git information,
container/helm artifacts produced, etc).
End event: indicates the end of a pipeline run (once per run).
To use this interface, you need to have a valid CI key with the scope corresponding to the component (or with account scope).
operationId: ci-webhook
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/CodeNowCIEvent"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: ci-webhook 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/clusters:
get:
tags:
- Clusters
summary: List of clusters
description: The operation allows you to retrieve a collection of all available
clusters. A cluster constitutes a managed group of interconnected worker nodes
that run containerized applications.
operationId: cluster_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: allowedOps
in: query
required: false
explode: false
schema:
type: array
items:
type: string
default:
- detail
responses:
"200":
description: List of clusters
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/Cluster"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers:
get:
tags:
- Containers
summary: List of containers
description: "The operation allows you to retrieve a collection of all available\
\ containers. A container constitutes a collection of pre-written and reusable\
\ code components, functions, and modules that enhance software development\
\ efficiency."
operationId: container_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: allowedOps
in: query
required: false
explode: false
schema:
type: array
items:
type: string
default:
- detail
responses:
"200":
description: List of containers
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ContainerComponentResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
post:
tags:
- Containers
summary: Create a container
description: "The operation allows you to create a new container. A container\
\ constitutes a collection of pre-written and reusable code components, functions,\
\ and modules that enhance software development efficiency."
operationId: container_create
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerCreateRequest"
required: true
responses:
"200":
description: Container detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerCreateResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers/{containerId}:
get:
tags:
- Containers
summary: Get a container
description: "The operation allows you to retrieve details about a specific\
\ container. A container constitutes a collection of pre-written and reusable\
\ code components, functions, and modules that enhance software development\
\ efficiency."
operationId: container_get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
type: string
responses:
"200":
description: Container detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerComponentResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Containers
summary: Update a container
description: "The operation allows you to update a specific container, changing\
\ some of its properties. Any properties not specified in the request body\
\ will stay unchanged."
operationId: container_update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerUpdateRequest"
required: true
responses:
"200":
description: Container was updated
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
delete:
tags:
- Containers
summary: Delete a container
description: The operation allows you to remove a specific container from the
system permanently.
operationId: container_delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
type: string
responses:
"200":
description: Container was deleted.
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers/{containerId}/builds:
get:
tags:
- Container Builds
summary: List container builds.
operationId: container-builds-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
- name: page
in: query
required: false
explode: false
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: size
in: query
required: false
explode: false
schema:
minimum: 0
exclusiveMinimum: true
type: integer
format: int32
default: 10
responses:
"200":
description: Page of builds
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/Page_ContainerBuildResponse_"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
post:
tags:
- Container Builds
summary: Trigger a container build.
operationId: container-builds-trigger
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerBuildRequest"
required: true
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers/{containerId}/builds/{id}:
get:
tags:
- Container Builds
summary: Get a container build detail
operationId: container-builds-detail
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
- name: expand
in: query
explode: false
schema:
type: array
nullable: true
items:
$ref: "#/components/schemas/Expand_1"
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers/{containerId}/builds/{id}/cancel:
patch:
tags:
- Container Builds
summary: Cancel a container build.
operationId: container-builds-cancel
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers/{containerId}/builds/{id}/labels/attach:
post:
tags:
- Container Builds
summary: Attach a label to a container build
description: "Attaches a label to the build. If labelId is not provided, a new\
\ label will be created using text and color."
operationId: container-builds-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerBuildLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: container-builds-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/containers/{containerId}/builds/{id}/labels/detach:
post:
tags:
- Container Builds
summary: Detach a label from a container build
description: Detaches a label from the build.
operationId: container-builds-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerBuildLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: container-builds-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/containers/{containerId}/builds/{id}/rerun:
post:
tags:
- Container Builds
summary: Rerun a failed container build.
operationId: container-builds-rerun
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers/{containerId}/ci-config:
get:
tags:
- Container CI configurations
summary: Get CI config
description: The operation allows you to retrieve details about a CI config
of a specific container and branch.
operationId: container-ci-configs-get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
- name: branch
in: query
required: true
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: CI config detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerCiConfigResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Container CI configurations
summary: Update CI config
description: The operation allows you to update CI config of a specific container
and branch.
operationId: container-ci-configs-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
- name: branch
in: query
required: true
explode: false
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerCiConfigUpdateRequest"
required: true
responses:
"200":
description: CI config detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers/{containerId}/ci-config/settings:
get:
tags:
- Container CI configurations
summary: Get CI config settings
description: The operation allows you to retrieve CI config settings.
operationId: container-ci-configs-settings-get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: CI config settings
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerCiConfigSettingsResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Container CI configurations
summary: Update CI config settings
description: The operation allows you to update CI config settings.
operationId: container-ci-configs-settings-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerCiConfigSettingsUpdateRequest"
required: true
responses:
"200":
description: CI config settings updated
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers/{containerId}/labels/attach:
post:
tags:
- Containers
summary: Attach a label to a container
description: "Attaches a label to the container. If labelId is not provided,\
\ a new label will be created using text and color."
operationId: container-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: container-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/containers/{containerId}/labels/detach:
post:
tags:
- Containers
summary: Detach a label from a container
description: Detaches a label from the container.
operationId: container-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ContainerLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: container-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/containers/{containerId}/releases:
get:
tags:
- Container Releases
summary: Retrieve a list of container releases.
operationId: container-releases-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: List of container releases
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ContainerRelease"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/containers/{containerId}/triggers:
get:
tags:
- Container Triggers
summary: Get container codenow triggers
operationId: container-triggers
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: Container triggers response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/CodenowTriggersResponse_1"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Container Triggers
summary: Update container codenow triggers
operationId: container-triggers-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: containerId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/CodenowTriggersUpdateRequest_1"
required: true
responses:
"200":
description: Container triggers were updated.
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/environments:
get:
tags:
- Environments
summary: List of environments
description: |-
The operation allows you to retrieve a collection of all available environments.
Environments are isolated spaces where users can interact with specific resources and data.
operationId: environment_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: expand
in: query
description: Allows to expand additional data
required: false
explode: false
schema:
type: array
items:
$ref: "#/components/schemas/Expand_2"
default:
- ""
responses:
"200":
description: List of environments
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/Environment"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
post:
tags:
- Environments
summary: Create an environment
description: |-
The operation allows you to create a new environment.
Environments are isolated spaces where users can interact with specific resources and data.
operationId: environment_create
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/EnvironmentCreateRequest"
required: true
responses:
"200":
description: Environment detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/Environment"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/environments/{environmentId}:
get:
tags:
- Environments
summary: Get an environment
description: The operation allows you to retrieve details about a specific environment.
Environments are isolated spaces where users can interact with specific resources
and data.
operationId: environment_get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: environmentId
in: path
required: true
schema:
type: string
- name: expand
in: query
explode: false
schema:
type: array
items:
$ref: "#/components/schemas/Expand_2"
default:
- ""
responses:
"200":
description: Environment detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/Environment"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
delete:
tags:
- Environments
summary: Delete an environment
description: "The operation allows you to remove a specific environment from\
\ the system permanently. However, before you can delete the environment,\
\ you must ensure that all associated resources and data within that environment\
\ are removed. If any resources remain, the operation will fail, and the environment\
\ will not be deleted."
operationId: environment_delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: environmentId
in: path
required: true
schema:
type: string
responses:
"200":
description: Environment was deleted.
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/environments/{environmentId}/labels/attach:
post:
tags:
- Environments
summary: Attach a label to an environment
description: "Attaches a label to the environment. If labelId is not provided,\
\ a new label will be created using text and color."
operationId: environment-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: environmentId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/EnvironmentLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: environment-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/environments/{environmentId}/labels/detach:
post:
tags:
- Environments
summary: Detach a label from an environment
description: Detaches a label from the environment.
operationId: environment-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: environmentId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/EnvironmentLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: environment-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/labels:
get:
tags:
- Labels
summary: List labels
description: Lists all labels for the current account.
operationId: labels-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: labels-list 200 response
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/LabelResponse"
post:
tags:
- Labels
summary: Create a label
description: Creates a new label. Optionally attaches it to specified resources.
operationId: label-create
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelCreateRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: label-create 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/labels/{labelId}:
get:
tags:
- Labels
summary: Get a label
description: Gets label detail including list of attached resources.
operationId: label-get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: labelId
in: path
description: Label ID
required: true
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: label-get 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/DetailedLabelResponse"
put:
tags:
- Labels
summary: Update a label
description: Updates label properties. Only provided fields will be updated.
operationId: label-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: labelId
in: path
description: Label ID
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelUpdateRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: label-update 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
delete:
tags:
- Labels
summary: Delete a label
description: Deletes a label and removes all its resource associations.
operationId: label-delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: labelId
in: path
description: Label ID
required: true
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: label-delete 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/labels/{labelId}/attach:
post:
tags:
- Labels
summary: Attach a resource to a label
description: Attaches a resource of specified type and ID to the label.
operationId: label-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: labelId
in: path
description: Label ID
required: true
schema:
minLength: 1
type: string
- name: resourceType
in: query
description: Resource type
required: true
explode: false
schema:
$ref: "#/components/schemas/LabelResourceType"
- name: resourceId
in: query
description: Resource ID
required: true
explode: false
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: label-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/labels/{labelId}/detach:
post:
tags:
- Labels
summary: Detach a resource from a label
description: Detaches a resource of specified type and ID from the label.
operationId: label-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: labelId
in: path
description: Label ID
required: true
schema:
minLength: 1
type: string
- name: resourceType
in: query
description: Resource type
required: true
explode: false
schema:
$ref: "#/components/schemas/LabelResourceType"
- name: resourceId
in: query
description: Resource ID
required: true
explode: false
schema:
minLength: 1
type: string
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: label-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/labels/{labelId}/multi:
post:
tags:
- Labels
summary: Bulk attach/detach resources
description: Performs bulk attach and detach operations for resources on a label.
Processed as a background job.
operationId: label-multi
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: labelId
in: path
description: Label ID
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelMultiRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: label-multi 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelMultiResponse"
/libraries:
get:
tags:
- Libraries
summary: List of libraries
description: "The operation allows you to retrieve a collection of all available\
\ libraries. A library constitutes a collection of pre-written and reusable\
\ code components, functions, and modules that enhance software development\
\ efficiency."
operationId: library_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: allowedOps
in: query
required: false
explode: false
schema:
type: array
items:
type: string
default:
- detail
responses:
"200":
description: List of libraries
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/LibraryComponentResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
post:
tags:
- Libraries
summary: Create a library
description: "The operation allows you to create a new library. A library constitutes\
\ a collection of pre-written and reusable code components, functions, and\
\ modules that enhance software development efficiency."
operationId: library_create
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/LibraryCreateRequestV2"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryCreateRequest"
example: null
required: true
responses:
"200":
description: Library detail
content:
application/vnd.codenow.v2+json:
schema:
$ref: "#/components/schemas/LibraryCreateResponse"
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryCreateResponse"
example: null
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/libraries/{libraryId}:
get:
tags:
- Libraries
summary: Get a library
description: "The operation allows you to retrieve details about a specific\
\ library. A library constitutes a collection of pre-written and reusable\
\ code components, functions, and modules that enhance software development\
\ efficiency."
operationId: library_get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
type: string
responses:
"200":
description: Library detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryComponentResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Libraries
summary: Update a library
description: "The operation allows you to update a specific library, changing\
\ some of its properties. Any properties not specified in the request body\
\ will stay unchanged."
operationId: library_update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryUpdateRequest"
required: true
responses:
"200":
description: Library was updated
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
delete:
tags:
- Libraries
summary: Delete a library
description: The operation allows you to remove a specific library from the
system permanently.
operationId: library_delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
type: string
responses:
"200":
description: Library was deleted.
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/libraries/{libraryId}/builds:
get:
tags:
- Library Builds
summary: List library builds.
operationId: library-builds-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
- name: page
in: query
required: false
explode: false
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: size
in: query
required: false
explode: false
schema:
minimum: 0
exclusiveMinimum: true
type: integer
format: int32
default: 10
responses:
"200":
description: Page of builds
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/Page_LibraryBuildResponse_"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
post:
tags:
- Library Builds
summary: Trigger a library build.
operationId: library-builds-trigger
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryBuildRequest"
required: true
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/libraries/{libraryId}/builds/{id}:
get:
tags:
- Library Builds
summary: Get a library build detail
operationId: library-builds-detail
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
- name: expand
in: query
explode: false
schema:
type: array
nullable: true
items:
$ref: "#/components/schemas/Expand_1"
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/libraries/{libraryId}/builds/{id}/cancel:
patch:
tags:
- Library Builds
summary: Cancel a library build.
operationId: library-builds-cancel
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/libraries/{libraryId}/builds/{id}/labels/attach:
post:
tags:
- Library Builds
summary: Attach a label to a library build
description: "Attaches a label to the build. If labelId is not provided, a new\
\ label will be created using text and color."
operationId: library-builds-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryBuildLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: library-builds-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/libraries/{libraryId}/builds/{id}/labels/detach:
post:
tags:
- Library Builds
summary: Detach a label from a library build
description: Detaches a label from the build.
operationId: library-builds-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
- name: id
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryBuildLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: library-builds-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/libraries/{libraryId}/builds/{id}/rerun:
post:
tags:
- Library Builds
summary: Rerun a failed library build.
operationId: library-builds-rerun
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: Detail of the build
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryBuildResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/libraries/{libraryId}/ci-config:
get:
tags:
- Library CI configurations
summary: Get CI config
description: The operation allows you to retrieve details about a CI config
of a specific library and branch.
operationId: libraries-ci-configs-get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
- name: branch
in: query
required: true
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: CI config detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryCiConfigResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Library CI configurations
summary: Update CI config
description: The operation allows you to update CI config of a specific library
and branch.
operationId: libraries-ci-configs-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
- name: branch
in: query
required: true
explode: false
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryCiConfigUpdateRequest"
required: true
responses:
"200":
description: CI config detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/libraries/{libraryId}/ci-config/settings:
get:
tags:
- Library CI configurations
summary: Get CI config settings
description: The operation allows you to retrieve CI config settings.
operationId: library-ci-configs-settings-get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: CI config settings
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryCiConfigSettingsResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Library CI configurations
summary: Update CI config settings
description: The operation allows you to update CI config settings.
operationId: libraries-ci-configs-settings-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryCiConfigSettingsUpdateRequest"
required: true
responses:
"200":
description: CI config settings updated
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/libraries/{libraryId}/labels/attach:
post:
tags:
- Libraries
summary: Attach a label to a library
description: "Attaches a label to the library. If labelId is not provided, a\
\ new label will be created using text and color."
operationId: library-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: library-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/libraries/{libraryId}/labels/detach:
post:
tags:
- Libraries
summary: Detach a label from a library
description: Detaches a label from the library.
operationId: library-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LibraryLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: library-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/libraries/{libraryId}/releases:
get:
tags:
- Library Releases
summary: Retrieve a list of library releases.
operationId: library-releases-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: List of library releases
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/LibraryRelease"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/libraries/{libraryId}/triggers:
get:
tags:
- Library Triggers
summary: Get library codenow triggers
operationId: library-triggers
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: Library triggers response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/CodenowTriggersResponse_2"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Library Triggers
summary: Update library codenow triggers
operationId: library-triggers-update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: libraryId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/CodenowTriggersUpdateRequest_2"
required: true
responses:
"200":
description: Library triggers were updated.
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/managed-services:
get:
tags:
- Managed Services
summary: List of managed services
description: The operation allows you to retrieve a collection of all available
managed services. Managed services are specialized resources provided and
maintained by CodeNOW designed to streamline and handle specific functions.
You can limit the results to a single deployment environment by providing
an environmentId query parameter.
operationId: managed_service_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: environmentId
in: query
explode: false
schema:
type: string
nullable: true
responses:
"200":
description: List of managed services
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ManagedServiceListItem"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
post:
tags:
- Managed Services
summary: Create a managed service
description: The operation allows you to create a new managed service.Managed
services are specialized resources provided and maintained by CodeNOW designed
to streamline and handle specific functions.
operationId: managed_service_create
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ManagedServiceCreateRequest"
required: true
responses:
"200":
description: Managed service detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ManagedServiceCreateResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/managed-services/{serviceId}:
get:
tags:
- Managed Services
summary: Get a managed service
description: The operation allows you to retrieve details about a specific managed
service. Managed services are specialized resources provided and maintained
by CodeNOW designed to streamline and handle specific functions.
operationId: managed_service_get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: serviceId
in: path
required: true
schema:
type: string
responses:
"200":
description: Managed service detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ManagedService"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
put:
tags:
- Managed Services
summary: Update a managed service
description: "The operation allows you to update a specific managed service,\
\ changing some of its properties. Any properties not specified in the request\
\ body will stay unchanged."
operationId: managed_service_update
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: serviceId
in: path
required: true
schema:
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ManagedServiceUpdateRequest"
required: true
responses:
"200":
description: Managed service was updated
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
delete:
tags:
- Managed Services
summary: Delete a managed service
description: The operation allows you to remove a specific managed service from
the system permanently.
operationId: managed_service_delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: serviceId
in: path
required: true
schema:
type: string
responses:
"200":
description: Managed service was deleted.
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/managed-services/{serviceId}/labels/attach:
post:
tags:
- Managed Services
summary: Attach a label to a managed service
description: "Attaches a label to the managed service. If labelId is not provided,\
\ a new label will be created using text and color."
operationId: managed-service-labels-attach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: serviceId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ManagedServiceLabelAttachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: managed-service-labels-attach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/LabelResponse"
/managed-services/{serviceId}/labels/detach:
post:
tags:
- Managed Services
summary: Detach a label from a managed service
description: Detaches a label from the managed service.
operationId: managed-service-labels-detach
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: serviceId
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ManagedServiceLabelDetachRequest"
required: true
responses:
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
"200":
description: managed-service-labels-detach 200 response
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
/scm/provider/{providerType}/{providerId}/spaces:
get:
tags:
- Scm Providers
summary: List SCM provider's spaces
description: Lists Source Code Management provider's spaces.
operationId: scm-spaces-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: providerType
in: path
description: |
Type of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
required: true
schema:
type: string
- name: providerId
in: path
description: |
Instance ID of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
required: true
schema:
type: string
responses:
"200":
description: List of SCM provider's spaces
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/GetSpacesResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/scm/provider/{providerType}/{providerId}/spaces/{spaceId}/repos:
get:
tags:
- Scm Providers
summary: List SCM repositories
description: Lists Source Code Management repositories.
operationId: scm-repository-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: providerType
in: path
description: |
Type of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
required: true
schema:
type: string
- name: providerId
in: path
description: |
Instance ID of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
required: true
schema:
type: string
- name: spaceId
in: path
description: |
ID of an existing SCM spaces where repository will be hosted.
Available repositories can be obtained through the /scm/{providerType}/{providerId}/spaces endpoint.
required: true
schema:
type: string
- name: monorepo
in: query
description: |
Context for creation of the new application component.
The parameter affects occupied field in the response.
required: true
explode: false
schema:
type: boolean
responses:
"200":
description: List of SCM repositories
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ScmRepository"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/scm/provider/{providerType}/{providerId}/spaces/{spaceId}/repos/{repositoryId}/tree:
get:
tags:
- Scm Providers
summary: SCM repository tree
description: Tree of the Source Code Management repository. The operation returns
one level of the tree.
operationId: scm-repository-tree
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: providerType
in: path
description: |
Type of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
required: true
schema:
type: string
- name: providerId
in: path
description: |
Instance ID of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
required: true
schema:
type: string
- name: spaceId
in: path
description: |
ID of an existing SCM spaces where repository will be hosted.
Available repositories can be obtained through the /scm/{providerType}/{providerId}/spaces endpoint.
required: true
schema:
type: string
- name: repositoryId
in: path
description: |
ID of an existing SCM repository to which the component should be placed.
Available repositories can be obtained through the /scm/{providerType}/{providerId}/spaces/{spaceId}/repos endpoint.
required: true
schema:
type: string
- name: treeId
in: query
description: |
ID of the tree that represents folder in the repository which the operation will return.
explode: false
schema:
type: string
nullable: true
responses:
"200":
description: The SCM repository tree
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/RepositoryTreeItem"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/scm/providers:
get:
tags:
- Scm Providers
summary: List SCM providers
description: Lists Source Code Management providers.
operationId: scm-providers-list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: withDisabled
in: query
description: |
Whether to include disabled SCM providers
required: true
explode: false
schema:
type: boolean
default: false
responses:
"200":
description: List of SCM providers
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ScmProviderResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/teams:
get:
tags:
- Teams
summary: List teams
operationId: team_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"200":
description: List of teams
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/TeamListItemResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
post:
tags:
- Teams
summary: Create new team
description: The operation creates new team.
operationId: team_create
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/TeamCreateRequest"
required: true
responses:
"200":
description: Team detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/TeamResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/teams/{teamName}:
get:
tags:
- Teams
summary: Get details of selected team
description: "The operation allows you to retrieve details about one team, including\
\ its members."
operationId: team_get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: teamName
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: Team detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/TeamResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
delete:
tags:
- Teams
summary: Delete selected team
description: The operation allows you to remove a specific team from the system
permanently.
operationId: team_delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: teamName
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: Team was deleted
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/teams/{teamName}/members:
post:
tags:
- Teams
summary: Add member to selected team
description: The operation allows you to add member to a specific team.
operationId: team_member_add
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: teamName
in: path
required: true
schema:
minLength: 1
type: string
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/TeamMemberAddRequest"
required: true
responses:
"200":
description: Team member was added
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/teams/{teamName}/members/{userName}:
delete:
tags:
- Teams
summary: Delete member of selected team
description: The operation allows you to remove member from a specific team.
operationId: team_member_delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: teamName
in: path
required: true
schema:
minLength: 1
type: string
- name: userName
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: Team member was removed
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/templates/application_components:
get:
tags:
- Templates
summary: List of application component templates
description: "The operation allows you to retrieve a collection of all available\
\ application component templates, which can be used to configure the template\
\ property of the ApplicationComponentCreateRequest."
operationId: templates_application-component_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"200":
description: List of application component templates
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/Template"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/templates/libraries:
get:
tags:
- Templates
summary: List of library templates
description: "The operation allows you to retrieve a collection of all available\
\ library templates, which can be used to configure the template property\
\ of the LibraryCreateRequest."
operationId: templates_library_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"200":
description: List of library templates
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/Template"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/templates/managed_services:
get:
tags:
- Templates
summary: List of managed services templates
description: The operation allows you to retrieve a collection of all available
managed services templates.
operationId: templates_managed-services_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"200":
description: List of managed services templates
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/ManagedComponentTemplateResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/templates/managed_services/{mangedServiceTemplateId}:
get:
tags:
- Templates
summary: Detail of managed services template
description: Contains user configurable properties for managed services template.
operationId: templates_managed-services_detail
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: mangedServiceTemplateId
in: path
required: true
schema:
type: string
- name: version
in: query
explode: false
schema:
type: string
nullable: true
responses:
"200":
description: Detail of managed service template
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/ManagedComponentTemplatePropertyResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/user:
get:
tags:
- User
summary: Get logged in user details
operationId: user_get
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"200":
description: User detail
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/UserController.UserDetail"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/user/ssh_keys:
get:
tags:
- Git SSH keys
summary: Retrieve list of public SSH keys
description: The operation retrieves a list of public SSH keys for the current
user.
operationId: ssh_keys_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"200":
description: List of public SSH keys
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/UserSshKey"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
post:
tags:
- Git SSH keys
summary: Upload new public SSH key
description: The operation uploads new public SSH key for the current user.
operationId: ssh_keys_upload
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
requestBody:
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/UserSshKeyUploadRequest"
required: true
responses:
"200":
description: Public SSH key uploaded successfully
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/user/ssh_keys/{sshKeyId}:
delete:
tags:
- Git SSH keys
summary: Delete existing public SSH key
description: The operation deletes existing public SSH key for the current user.
operationId: ssh_keys_delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: sshKeyId
in: path
required: true
schema:
type: integer
format: int32
responses:
"200":
description: SSH key deleted
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/users:
get:
tags:
- User
summary: List of users
description: The operation allows you to retrieve a collection of all users.
operationId: user_list
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
responses:
"200":
description: List of users
content:
application/vnd.codenow.v1+json:
schema:
type: array
items:
$ref: "#/components/schemas/User"
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
/users/{userName}:
delete:
tags:
- User
summary: Delete selected user
description: The operation allows you to remove a specific user from the system.
operationId: user_delete
parameters:
- name: X-Codenow-Api-Key
in: header
description: CodeNOW API Key
required: true
schema:
type: object
- name: userName
in: path
required: true
schema:
minLength: 1
type: string
responses:
"200":
description: User was deleted
content:
application/vnd.codenow.v1+json:
schema:
$ref: "#/components/schemas/OkResponse"
"409":
description: Such a user does not exist
"400":
description: "The request was unacceptable, often due to missing a required\
\ parameter."
"401":
description: No valid API key provided.
"403":
description: The API key doesn't have permissions to perform the request.
"404":
description: Resource not found.
"429":
description: Too many requests hit the API too quickly. We recommend an
exponential backoff of your requests.
"500":
description: Something went wrong on CodeNOW's end.
components:
schemas:
AccessControl:
type: object
properties:
unlimited:
type: boolean
description: "
A boolean flag indicating whether all user-defined environments\
\ can access the service via the Connect Services feature\
\ of Application Components.If set to false, only the environments specified\
\ in allowFrom will be able to connect.
"
allowFrom:
type: array
description: "
A list of IDs of all environments, from which the service\
\ can be accessed via the Connect Services feature of Application\
\ Components.To obtain these identifiers, use the GET /environments\
\ operation to retrieve a list of available environments.
This field\
\ should only be specified, when unlimited is set to false\
\ or null!"
nullable: true
items:
type: string
ActionType:
type: string
description: |
Action that will be performed on the SCM repository.
CREATE: New SCM repository will be created for the component.
LINK: The component will be linked to an existing SCM repository (unique ID of the repository will be required).
enum:
- CREATE
- LINK
AppComponentState:
type: string
description: |
State of the application component.
CREATING - Application component is in the process of being created.
READY - Application component is ready to be used.
FAILED - Application component creation has failed.
DELETING - Application component is in the process of being deleted.
enum:
- CREATING
- READY
- FAILED
- DELETING
ApplicationBuildLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to an application build/package. Provide\
\ labelId to use an existing label, or text+color to create a new one."
ApplicationBuildLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from an application build/package
ApplicationComponentBuildLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to an application component build. Provide\
\ labelId to use an existing label, or text+color to create a new one."
ApplicationComponentBuildLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from an application component build
ApplicationComponentBuildRequest:
required:
- branch
type: object
properties:
version:
maxLength: 63
type: string
description: |
The version of the application component to be built.
For PREVIEW builds, the version is ignored and a preview version is generated.
nullable: true
branch:
minLength: 1
type: string
description: |
The branch of the application component to be built.
buildType:
description: |
The type of the build to be performed.
Possible values:
- RELEASE (default): A release build, i.e. 1.0.0
- PREVIEW: A preview build, unnamed version which will be directly deployed and discarded afterwards
- PRERELEASE: Similar to preview build, but the user has the choice to name the version, i.e. 1.7.0-prerelease1.
nullable: true
allOf:
- $ref: "#/components/schemas/BuildType"
default: RELEASE
pipeline:
type: string
description: |
Name of the pipeline to be used for the build.
If not provided, the default pipeline for the application component will be used
(can be global or configured per branch).
nullable: true
deployTo:
type: array
description: |
List of deployments to be performed after successful build.
nullable: true
items:
$ref: "#/components/schemas/Deployment_1"
applicationPackage:
type: string
description: |
Optional application package version to be created after successful build.
Applicable only for RELEASE builds.
Version pattern can be used, ie. 1.5.+
nullable: true
ApplicationComponentBuildResponse:
required:
- applicationComponentId
- createdAt
- id
- status
type: object
properties:
id:
type: string
description:
The unique identifier of the build.
url:
type: string
description: URL to the build's dashboard.
applicationComponentId:
type: string
description:
The unique identifier of the application component.
version:
type: string
description:
The version of the application component build.
buildType:
description:
The type of the build.
allOf:
- $ref: "#/components/schemas/BuildType"
branch:
type: string
description:
The branch from which the application component build
was created .
commit:
description:
Commit from which the build was created.
nullable: true
allOf:
- $ref: "#/components/schemas/CommitInfo"
status:
description:
The status of the build.
allOf:
- $ref: "#/components/schemas/BuildState"
codeQuality:
description: |
Code Quality information
Not all pipelines will provide this information.
nullable: true
allOf:
- $ref: "#/components/schemas/CodeQuality"
requestedBy:
type: string
description: |
The user who requested the build.
createdAt:
type: string
description: The time when the builds was requested
format: date-time
archived:
type: boolean
description: |
Whether the build is archived or not.
Archived builds do not provide additional information (logs, code quality, etc.)
deployTo:
type: array
description: |+
The list of deployment targets after successful build.
nullable: true
items:
$ref: "#/components/schemas/Deployment_1"
actions:
type: array
description: |
The list of actions that can be performed on the build.
- cancel
- build can be cancelled
- rerun
- build can be rerun (after failure or cancellation)
items:
type: string
pipeline:
type: string
description: |
The pipeline used to create the build.
errorMessage:
type: string
description: |
The error message if the build failed.
nullable: true
applicationPackage:
type: string
description:
Version pattern to specify application package to be
created after successful build.
nullable: true
results:
type: array
description: |
CI results associated with the build
.
nullable: true
items:
$ref: "#/components/schemas/CiResult"
ciProvider:
type: string
description: |
CI Provider associated with the build
codenow - uses CodeNow CI
external - uses external CI
resourceLabels:
type: array
description: Labels attached to this build.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
ApplicationComponentCiConfigResponse:
required:
- advancedMode
- build
- runtime
type: object
properties:
advancedMode:
description: |
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.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigResponse.AdvancedMode"
build:
description: |
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.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigResponse.Build"
runtime:
description: |
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.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigResponse.Runtime"
ApplicationComponentCiConfigResponse.AdvancedMode:
required:
- enabled
type: object
properties:
enabled:
type: boolean
description:
A boolean flag indicating enablement of application component
advanced mode.
ApplicationComponentCiConfigResponse.Build:
required:
- environmentVariables
- image
- pipelines
type: object
properties:
image:
type: string
description: |
The field specifies the container utilized for executing build
and unit test tasks within the Continuous Integration (CI) pipeline.
environmentVariables:
type: array
description: |
The environmentVariables section configures custom environment variables
that are utilized within the Continuous Integration (CI) pipeline.
items:
$ref: "#/components/schemas/ApplicationComponentCiConfigResponse.Build.EnvironmentVariable"
pipelines:
description: |
The pipelines section defines and configures the specific pipelines
to be executed for release builds and preview builds.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigResponse.Build.Pipelines"
ApplicationComponentCiConfigResponse.Build.EnvironmentVariable:
required:
- name
- value
type: object
properties:
name:
type: string
description:
The name of the environment variable.
value:
type: string
description:
The value of the environment variable.
ApplicationComponentCiConfigResponse.Build.Pipelines:
required:
- preview
- release
type: object
properties:
preview:
type: string
description: |
Defines the pipeline id for performed preview builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.
release:
type: string
description: |
Defines the pipeline id for performed release builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.
ApplicationComponentCiConfigResponse.Runtime:
required:
- endpoints
- image
- port
type: object
properties:
image:
type: string
description: |
The base image the will be used for templating on-the-fly generated Dockerfile.
port:
type: string
description: |
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:
description: |
The endpoints section influences the exposure of components within a Kubernetes cluster.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigResponse.Runtime.Endpoints"
java:
description: |
The java section sets parameters for the Java process running inside the container that is result of CI pipeline.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigResponse.Runtime.Java"
ApplicationComponentCiConfigResponse.Runtime.Endpoints:
required:
- external
type: object
properties:
external:
description: |
The external section configures the behavior of exposing services outside the Kubernetes cluster.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigResponse.Runtime.Endpoints.External"
ApplicationComponentCiConfigResponse.Runtime.Endpoints.External:
required:
- enabled
type: object
properties:
enabled:
type: boolean
description: |
The field determines whether a service will be exposed outside of the Kubernetes cluster.
ApplicationComponentCiConfigResponse.Runtime.Java:
required:
- jvmParameters
type: object
properties:
jvmParameters:
type: string
description:
The field sets up JVM (Java Virtual Machine) parameters
for the Java process running inside the container that is result of CI
pipeline.
ApplicationComponentCiConfigSettingsResponse:
required:
- globalPipelinesConfiguration
type: object
properties:
globalPipelinesConfiguration:
type: boolean
description: "
A boolean flag indicating whether pipeline settings\
\ are globally configured for the entire repository. If set to false,\
\ the pipeline settings are independently customized for individual branches."
ApplicationComponentCiConfigSettingsUpdateRequest:
required:
- globalPipelinesConfiguration
type: object
properties:
globalPipelinesConfiguration:
type: boolean
description: "
A boolean flag indicating whether pipeline settings\
\ are globally configured for the entire repository. If set to false,\
\ the pipeline settings are independently customized for individual branches."
ApplicationComponentCiConfigUpdateRequest:
type: object
properties:
advancedMode:
description: |
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.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigUpdateRequest.AdvancedMode"
build:
description: |
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.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigUpdateRequest.Build"
runtime:
description: |
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.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigUpdateRequest.Runtime"
ApplicationComponentCiConfigUpdateRequest.AdvancedMode:
required:
- enabled
type: object
properties:
enabled:
type: boolean
description:
A boolean flag indicating enablement of application component
advanced mode.
ApplicationComponentCiConfigUpdateRequest.Build:
type: object
properties:
image:
type: string
description: |
The field specifies the container utilized for executing build
and unit test tasks within the Continuous Integration (CI) pipeline.
environmentVariables:
type: array
description: |
The environmentVariables section configures custom environment variables
that are utilized within the Continuous Integration (CI) pipeline.
items:
$ref: "#/components/schemas/ApplicationComponentCiConfigUpdateRequest.Build.EnvironmentVariable"
pipelines:
description: |
The pipelines section defines and configures the specific pipelines
to be executed for release builds and preview builds.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigUpdateRequest.Build.Pipelines"
ApplicationComponentCiConfigUpdateRequest.Build.EnvironmentVariable:
required:
- name
- value
type: object
properties:
name:
minLength: 1
type: string
description:
The name of the environment variable.
value:
minLength: 1
type: string
description:
The value of the environment variable.
ApplicationComponentCiConfigUpdateRequest.Build.Pipelines:
type: object
properties:
preview:
type: string
description: |
Defines the pipeline id for performed preview builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.
release:
type: string
description: |
Defines the pipeline id for performed release builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.
ApplicationComponentCiConfigUpdateRequest.Runtime:
type: object
properties:
image:
type: string
description: |
The base image the will be used for templating on-the-fly generated Dockerfile.
port:
type: string
description: |
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:
description: |
The endpoints section influences the exposure of components within a Kubernetes cluster.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigUpdateRequest.Runtime.Endpoints"
java:
description: |
The java section sets parameters for the Java process running inside the container that is result of CI pipeline.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigUpdateRequest.Runtime.Java"
ApplicationComponentCiConfigUpdateRequest.Runtime.Endpoints:
type: object
properties:
external:
description: |
The external section configures the behavior of exposing services outside the Kubernetes cluster.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCiConfigUpdateRequest.Runtime.Endpoints.External"
ApplicationComponentCiConfigUpdateRequest.Runtime.Endpoints.External:
required:
- enabled
type: object
properties:
enabled:
type: boolean
description: |
The field determines whether a service will be exposed outside of the Kubernetes cluster.
ApplicationComponentCiConfigUpdateRequest.Runtime.Java:
required:
- jvmParameters
type: object
properties:
jvmParameters:
minLength: 1
type: string
description:
The field sets up JVM (Java Virtual Machine) parameters
for the Java process running inside the container that is result of CI
pipeline.
ApplicationComponentConfigStoreRequest:
type: object
properties:
configFiles:
type: array
description:
A list of configuration files affecting the component.
nullable: true
items:
$ref: "#/components/schemas/ApplicationComponentConfigStoreRequest.ContentEntry"
connections:
type: array
description: "
A list of all needed connected services, denoted by\
\ connection name, service type and a specific instance.
"
nullable: true
items:
$ref: "#/components/schemas/ConnectionsUpdateRequest.ConnectionRequest"
runtime:
description:
An object containing the runtime configuration specifications
for the component.
nullable: true
allOf:
- $ref: "#/components/schemas/RuntimeConfig"
ApplicationComponentConfigStoreRequest.ContentEntry:
required:
- content
- key
type: object
properties:
key:
type: string
description:
The name of the configuration file.
content:
type: string
description:
The content of the file. Must be base64-url encoded.
ApplicationComponentConnectionsConfigResponse:
required:
- connections
type: object
properties:
connections:
type: array
description: |-
An object containing the runtime configuration of the application component.
It represents the configuration file .codenow.config.yaml.
items:
$ref: "#/components/schemas/Connection"
ApplicationComponentCreateRequest:
required:
- name
- scm
- template
type: object
properties:
name:
type: string
description: |-
Human readable name of the component.
CodeNOW will generate an ID for the library based on this name.
description:
type: string
description:
Optional description of the component.
scm:
description: |-
Defines the repository in SCM.
Supported providers/actions can be obtained through the /scm/providers endpoint.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCreateRequest.Scm"
template:
description: |
Defines the template used for scaffolding the application component.
Example:
1) List available templates at /templates/application_components endpoint and choose the one desired.
2) Depending on the template, it may be necessary to attach required/optional properties in the request body. For example, a template property defined as:
```json
"properties": [
{
"name": "groupId",
"description": "Base Java package",
"type": "string",
"required": true
}
]
```
is mandatory and will be used like this:
```json
"properties": {
"groupId": "com.example"
}
```
3) Assemble and send final request, for example:
```json
{
"name": "example-comp1",
"description": "example-comp1",
"scm": {
"action": "CREATE",
"provider": "codenow"
},
"template": {
"id": "java-maven-generic",
"version": "4.1.0",
"properties": {
"groupId": "com.example"
}
}
}
```
4) Any omitted optional parameters will be replaced with default values.
allOf:
- $ref: "#/components/schemas/TemplateSpec"
ApplicationComponentCreateRequest.Scm:
required:
- action
- provider
type: object
properties:
action:
description:
Action that will be performed on the SCM repository.
allOf:
- $ref: "#/components/schemas/ActionType"
default: CREATE
provider:
type: string
description: |
Instance ID of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
If in doubt use "action": "CREATE", "provider": "codenow"
repositoryId:
type: string
description: |-
ID of an existing SCM repository to which the component should be linked.
It is only required for the LINK ActionType.
nullable: true
ApplicationComponentCreateRequestV2:
required:
- name
- scm
- template
type: object
properties:
name:
type: string
description: |-
Human readable name of the component.
CodeNOW will generate an ID for the library based on this name.
description:
type: string
description:
Optional description of the component.
scm:
description: |-
Defines the repository in SCM.
Supported providers/actions can be obtained through the /scm/providers endpoint.
allOf:
- $ref: "#/components/schemas/ApplicationComponentCreateRequestV2.Scm"
template:
description: |
Defines the template used for scaffolding the application component.
Example:
1) List available templates at /templates/application_components endpoint and choose the one desired.
2) Depending on the template, it may be necessary to attach required/optional properties in the request body. For example, a template property defined as:
```json
"properties": [
{
"name": "groupId",
"description": "Base Java package",
"type": "string",
"required": true
}
]
```
is mandatory and will be used like this:
```json
"properties": {
"groupId": "com.example"
}
```
3) Assemble and send final request, for example:
```json
{
"name": "example-comp1",
"description": "example-comp1",
"scm": {
"action": "CREATE",
"providerId": "codenow",
"providerType": "codenow",
"existingRepository": false,
"monoRepository": false,
"spaceId": "codenow"
},
"template": {
"id": "java-maven-generic",
"version": "4.1.0",
"custom": false,
"properties": {
"groupId": "com.example"
}
}
}
```
4) Any omitted optional parameters will be replaced with default values.
allOf:
- $ref: "#/components/schemas/TemplateSpecV2"
ApplicationComponentCreateRequestV2.Scm:
required:
- action
- existingRepository
- monoRepository
- providerId
- providerType
- spaceId
type: object
properties:
action:
description:
Action that will be performed on the SCM repository.
allOf:
- $ref: "#/components/schemas/ActionType"
default: CREATE
providerId:
minLength: 1
type: string
description: |
Instance ID of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
providerType:
minLength: 1
type: string
description: |
Type of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
existingRepository:
type: boolean
description: |
Defines if the new component will be created in existing repository:
- true: you must define spaceId and repositoryId of the existing repository in the request
- false: new repository will be created for the component
monoRepository:
type: boolean
description: |
Defines if the new component will be share repository with other components:
- true: you must define componentPath where the component will be hosted in the repository
- false: the component will be hosted in the root of the repository
componentPath:
pattern: "^[a-zA-Z0-9\\-_~./]*$"
type: string
description: |
Define path in the repository where the component will be placed.
nullable: true
spaceId:
type: string
description: |
ID of an existing SCM spaces where repository will be hosted.
Available repositories can be obtained through the /scm/provider/{providerType}/{providerId}/spaces endpoint.
repositoryId:
type: string
description: |
ID of an existing SCM repository to which the component should be placed.
Available repositories can be obtained through the /scm/provider/{providerType}/{providerId}/spaces/{spaceId}/repos endpoint.
nullable: true
ApplicationComponentCreateResponse:
required:
- createdAt
- createdBy
- id
- name
type: object
properties:
id:
type: string
description: |
Unique application component ID.
name:
type: string
description:
Human readable name of the component.
description:
type: string
description:
Description of the component.
templateId:
type: string
description:
ID of the template used for scaffolding the application
component.
state:
$ref: "#/components/schemas/AppComponentState"
createdAt:
type: string
description: |
The timestamp when the application component was created.
format: date-time
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the application component.
ApplicationComponentDeploymentConfig:
required:
- configFiles
- connections
- runtime
type: object
properties:
configFiles:
type: array
description:
A list of objects representing configuration files affecting
the component.
items:
$ref: "#/components/schemas/ApplicationComponentDeploymentConfig.AppComponentDeploymentConfigFileEntry"
connections:
type: array
description:
A list of objects representing connections to managed
or external services.
items:
$ref: "#/components/schemas/Connection"
runtime:
description:
An object containing the runtime configuration specifications
for the component.
allOf:
- $ref: "#/components/schemas/RuntimeConfig"
error:
type: boolean
errorMessage:
type: string
ApplicationComponentDeploymentConfig.AppComponentDeploymentConfigFileEntry:
required:
- content
- key
- source
- type
type: object
properties:
key:
type: string
description:
The name of the configuration file.
content:
type: string
description: "
The content of the file, base64 encoded.
"
type:
type: string
description: "
The type of the configuration file corresponds to its\
\ extension, providing important information about the expected formatting\
\ and content.
"
source:
description: "
Information about the origin of the configuration file.Possible values are: EXISTING, meaning that the file\
\ is present in this version of the configuration (most common state),\
\ PREVIOUS, meaning it has been extracted from a previous\
\ configuration version (useful when creating a higher version), and DEFAULT,\
\ meaning this file is part of the default configuration prepared by CodeNOW."
allOf:
- $ref: "#/components/schemas/ApplicationComponentDeploymentConfig.ConfigSource"
ApplicationComponentDeploymentConfig.ConfigSource:
type: string
enum:
- EXISTING
- PREVIOUS
- DEFAULT
ApplicationComponentEndpoint:
type: object
properties:
url:
type: string
description:
The URL address under which the application component
is accessible.
previewUrl:
type: string
description:
Preview URL address under which the application component
is accessible.
applicationComponentId:
type: string
description:
The unique identifier of the application component.
primary:
type: boolean
type:
description:
Type of endpoint.
allOf:
- $ref: "#/components/schemas/EndpointType"
ApplicationComponentLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to an application component. Provide\
\ labelId to use an existing label, or text+color to create a new one."
ApplicationComponentLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from an application component
ApplicationComponentRelease:
required:
- appComponentId
- version
type: object
properties:
appComponentId:
minLength: 1
type: string
description:
Unique identifier of the application component.
version:
minLength: 1
type: string
description:
Version number.
ApplicationComponentResponse:
required:
- applicationId
- ciSettings
- id
- name
- runtimeId
- scm
- settings
- state
- template
type: object
properties:
id:
type: string
description:
The unique identifier of the application component. Based
on the user-defined name.
name:
type: string
description: '
Human readable name of the application component.
'
description:
type: string
description:
The detailed textual description.
nullable: true
applicationId:
type: string
description:
ID of the application this component is part of.
state:
description:
The current life-cycle status of the application component.
allOf:
- $ref: "#/components/schemas/AppComponentState"
runtimeId:
type: string
description: |
Runtime id of the application component compatible with DNS-1123 label, based on id.
It must be used in certain places such as kubernetes labels. (Might be the same as id.)
template:
description:
Template specification for the application component.
allOf:
- $ref: "#/components/schemas/TemplateSpec"
scm:
description: "
An object containing Source Code Management (SCM) information,\
\ including provider, repository/project ID, HTTP clone URL, and SSH clone\
\ URL.
"
allOf:
- $ref: "#/components/schemas/ScmSpec"
error:
description: "
Error details, if any, encountered during the library\
\ creation process.
"
nullable: true
allOf:
- $ref: "#/components/schemas/ErrorSpec"
buildSystem:
type: string
description: "
The name of the build system used for compiling, testing,\
\ and packaging code within the library.
"
nullable: true
settings:
description: |
Basic settings for the component
allOf:
- $ref: "#/components/schemas/Settings"
ciSettings:
description: |
CI settings for the component
allOf:
- $ref: "#/components/schemas/CiSettings"
createdAt:
type: string
description: |
The timestamp when the application component was created. If the timestamp is unknown, the value will be returned as `null`.
format: date-time
nullable: true
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the application component.
If the user is unknown, the value will be returned as `null`.
nullable: true
resourceLabels:
type: array
description: Labels attached to this application component.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
ApplicationComponentRuntimeConfigResponse:
required:
- present
- runtimeConfig
type: object
properties:
runtimeConfig:
description: |-
An object containing the runtime configuration of the application component.
It represents the configuration file .codenow.config.yaml.
allOf:
- $ref: "#/components/schemas/RuntimeConfig"
present:
type: boolean
description: |-
A boolean flag indicating whether the configuration file .codenow.config.yaml
containing the runtime configuration exists in this component's repository.
If set to false, default runtime configuration is used.
ApplicationComponentUpdateRequest:
type: object
properties:
description:
type: string
description:
Human readable description of the application component.
nullable: true
contextPath:
type: string
description: |
Preferred context path for the application component.
Used for generating the URL for the application component in "endpoints" on deployment.
nullable: true
maxQueueSize:
type: integer
description:
The maximum number of builds kept before they are archived.
format: int32
nullable: true
ciSettings:
description: "
The CI settings for the library. If provided, the CI\
\ settings will be updated.
"
nullable: true
allOf:
- $ref: "#/components/schemas/CiSettings"
ApplicationCreateRequest:
type: object
properties:
name:
type: string
description:
type: string
nullable: true
relatedEnvironments:
type: array
nullable: true
items:
$ref: "#/components/schemas/EnvironmentRef"
ApplicationCreateRequestV2:
required:
- name
type: object
properties:
name:
type: string
description: Human-readable name of the application. Used to derive the
application id and runtime id.
example: My App
description:
type: string
description: Optional description of the application.
nullable: true
example: Customer-facing storefront
productionEnvironmentId:
type: string
description: Id of the environment to be treated as production. Must be
permitted by the related-environments policy (i.e. listed when mode =
WHITELIST).
nullable: true
example: prod
relatedEnvironments:
description: "Access policy controlling which environments may be used with\
\ this application. Omit for the default (mode = ANY, i.e. no constraint)."
nullable: true
allOf:
- $ref: "#/components/schemas/RelatedTargetsConfig"
relatedLabels:
description: "Access policy controlling which labels may be used with this\
\ application. Omit for the default (mode = ANY, i.e. no constraint)."
nullable: true
allOf:
- $ref: "#/components/schemas/RelatedTargetsConfig"
description: "Create-application payload (v2). Related deployment targets are\
\ expressed as access policies: each of `relatedEnvironments` and `relatedLabels`\
\ is an object `{mode, ids}` where `mode` selects between `ANY` (no constraint),\
\ `DENY_ALL` (none allowed) and `WHITELIST` (only listed ids allowed); `ids`\
\ is meaningful only when `mode = WHITELIST`."
ApplicationDeploymentConfigListItemResponse:
required:
- applicationId
- applicationVersion
- environmentId
- versionInterval
type: object
properties:
applicationId:
type: string
description: "
The unique identifier of the application this configuration\
\ belongs to. Any deployment configuration is fully identified by the\
\ combination of application ID, application version and environment ID."
applicationVersion:
type: string
description:
The application package version this configuration was
created for.
environmentId:
type: string
description:
The unique identifier of the environment this configuration
belongs to.
versionInterval:
description:
The range of application package versions this configuration
is currently applicable to. The intervals will adjust accordingly with
the creation and deletion of configurations.
allOf:
- $ref: "#/components/schemas/Interval"
createdAt:
type: string
description: |
The timestamp when the deployment configuration was created. If the timestamp is unknown, the value will be returned as `null`.
format: date-time
nullable: true
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the deployment configuration.
If the user is unknown, the value will be returned as `null`.
nullable: true
ApplicationDeploymentConfigResponse:
required:
- applicationId
- applicationVersion
- deploymentConfig
- environmentId
type: object
properties:
version:
type: string
description: "
The deployment configuration version given in the request.\
\ In most cases it will be identical to applicationVersion, but it can\
\ differ, e.g. when the specified configuration does not exist.
"
nullable: true
compatible:
type: boolean
description: "
A boolean flag indicating whether the deployment configuration\
\ can be used to deploy the specified application version to the given\
\ environment.
It will be set to false, if there are breaking changes\
\ between the given version and the version the configuration has been\
\ created for."
nullable: true
applicationId:
type: string
description: "
The unique identifier of the application this configuration\
\ belongs to. Any existing deployment configuration is fully identified\
\ by the combination of application, version and environment.
"
applicationVersion:
type: string
description:
The application package version this configuration was
created for.
environmentId:
type: string
description:
The unique identifier of the environment this configuration
belongs to.
versionInterval:
description:
The range of application package versions this configuration
is currently applicable to. The intervals will adjust accordingly with
the creation and deletion of configurations.
nullable: true
allOf:
- $ref: "#/components/schemas/Interval"
deploymentConfig:
type: object
additionalProperties:
$ref: "#/components/schemas/ApplicationComponentDeploymentConfig"
description: "
A map of configurations for individual application components\
\ contained in the application version, mapped by component ID.
"
createdAt:
type: string
description: |
The timestamp when the deployment configuration was created. If the timestamp is unknown, the value will be returned as `null`.
format: date-time
nullable: true
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the deployment configuration.
If the user is unknown, the value will be returned as `null`.
nullable: true
ApplicationDeploymentConfigStoreRequest:
required:
- applicationVersion
- deploymentConfig
- environmentId
type: object
properties:
applicationVersion:
minLength: 1
type: string
description:
The application package version this configuration will
be based on.
environmentId:
minLength: 1
type: string
description: |-
The unique identifier of the environment this configuration will belong to.
To obtain this identifier, use the GET /applications/:applicationId/related-environments
operation to retrieve a list of available related environments.
deploymentConfig:
maxProperties: 100
minProperties: 1
type: object
additionalProperties:
$ref: "#/components/schemas/ApplicationComponentConfigStoreRequest"
description: |-
A map of configuration requests for individual application components contained
in the application version, mapped by component ID.
ApplicationDeploymentCreateRequest:
required:
- environmentId
- version
type: object
properties:
environmentId:
minLength: 1
type: string
description: |-
The unique identifier of the environment the application should be deployed to.
To obtain this identifier, use the GET /applications/:applicationId/related-environments
operation to retrieve a list of available related environments.
version:
minLength: 1
type: string
description:
The application package version to be deployed.
ApplicationDeploymentCreateRequestV2:
required:
- version
type: object
properties:
version:
minLength: 1
type: string
description: Application package version to be deployed.
example: 1.4.0
environments:
type: array
description: Set of environment ids to deploy to. May be combined with `labels`;
the resulting target set is the union of both.
nullable: true
example:
- env-dev
- env-staging
items:
type: string
labels:
type: array
description: Set of label ids. Each label is resolved to the environments
it is associated with (resource type ENVIRONMENT); those environments
are merged into the deployment targets.
nullable: true
example:
- 3dfae88c-aac7-49bb-9eda-799613aad87f
items:
type: string
description: "Request to deploy an application version to one or more target\
\ environments. Targets may be given directly by id via `environments`, indirectly\
\ via `labels` (each label is resolved server-side to its associated ENVIRONMENT\
\ resources), or both. At least one of `environments` or `labels` must be\
\ non-empty. Per-environment deploy authorization is enforced across the resolved\
\ target set."
ApplicationDeploymentResponse:
required:
- applicationId
- configurationVersion
- dateCreated
- environmentId
- id
- name
- version
type: object
properties:
id:
type: string
description:
The internal unique identifier of the deployment.
format: uuid
applicationId:
minLength: 1
type: string
description:
The unique identifier of the deployed application.
environmentId:
minLength: 1
type: string
description:
The unique identifier of the environment the application
is deployed to.
version:
minLength: 1
type: string
description:
The deployed application package version.
configurationVersion:
type: string
description:
The deployment configuration version used for the deployment.
name:
type: string
description:
The user-friendly label for the deployment. It consists
of a combination of the application and environment IDs.
status:
description:
Current runtime status of the deployment.
allOf:
- $ref: "#/components/schemas/DeploymentStatus"
dateCreated:
type: string
description: |
The timestamp when the deployment was issued. It is an automatically generated value that records
the exact date and time when the deployment started.
format: date-time
endpoints:
type: array
description: |
A list of objects representing the URL addresses under which the individual application
components are available.
Please note, this list may differ from the one you see in the CodeNow UI.
nullable: true
items:
$ref: "#/components/schemas/ApplicationComponentEndpoint"
isPreview:
type: boolean
description: |
A boolean flag indicating whether any application components have been deployed directly
to the environment in form of a preview build.
nullable: true
errorCode:
type: string
nullable: true
errorMessage:
type: string
nullable: true
createdAt:
type: string
description: |
The timestamp when the deployment was issued. It is an automatically generated value that records
the exact date and time when the deployment started. If the timestamp is unknown, the value will be returned as `null`.
format: date-time
nullable: true
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the deployment.
If the user is unknown, the value will be returned as `null`.
nullable: true
ApplicationDeploymentResponseV2:
required:
- applicationId
- environmentId
type: object
properties:
applicationId:
minLength: 1
type: string
description: Identifier of the deployed application.
example: my-app
environmentId:
minLength: 1
type: string
description: Identifier of the target environment.
example: env-staging
customRouting:
type: boolean
description: "Whether custom DNS routing rules exist for this (application,\
\ environment). Only populated when the `routingRules` expand is requested."
nullable: true
deployment:
description: "Active deployment, if any."
nullable: true
allOf:
- $ref: "#/components/schemas/Deployment"
pendingDeployment:
description: "Queued deployment awaiting approval or execution, if any."
nullable: true
allOf:
- $ref: "#/components/schemas/PendingDeployment"
jobRun:
description: "In-flight job run targeting this (application, environment),\
\ if any."
nullable: true
allOf:
- $ref: "#/components/schemas/DeploymentJobRun"
description: "Composite view of an application deployment on a specific environment.\
\ The envelope keys the response by (applicationId, environmentId); each of\
\ the three nested blocks (`deployment`, `pendingDeployment`, `jobRun`) is\
\ populated only when relevant data exists AND the corresponding `expand`\
\ value is set on the request. A null `jobRun` does not mean \"no job ever\
\ ran\" — completed task groups are filtered out. `pendingDeployment` and\
\ `jobRun` are eventually consistent with each other; treat the pair as a\
\ snapshot."
ApplicationLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to an application. Provide labelId to\
\ use an existing label, or text+color to create a new one."
ApplicationLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from an application
ApplicationListResponseV2:
required:
- id
- name
- runtimeName
- status
type: object
properties:
abilities:
type: array
description: Operations the caller may perform on this application.
items:
type: string
id:
type: string
description: Unique identifier of the application.
runtimeName:
type: string
description: Runtime id of the application — DNS-1123-compatible derivative
of `id`.
name:
type: string
description: Human-readable name of the application.
description:
type: string
description: Description of the application.
nullable: true
status:
type: string
description: "Lifecycle status. READY = ready to use, DELETING = deletion\
\ in progress."
productionEnvironmentId:
type: string
description: "Id of the environment treated as production, if any."
nullable: true
createdAt:
type: string
description: Timestamp when the application was created. `null` if unknown.
format: date-time
nullable: true
createdBy:
type: string
description: Identifier of the user who created the application. `null`
if unknown.
nullable: true
resourceLabels:
type: array
description: Labels attached to this application. Populated only when the
list is requested with `expand=labels`.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
description: "Compact application entry for list responses (v2). Related deployment\
\ targets are intentionally omitted — fetch them per-application via `GET\
\ /applications/{applicationId}/deployment-targets`. Labels are returned only\
\ when requested via `expand=labels`."
ApplicationPackageCreateRequest:
required:
- components
- version
type: object
properties:
version:
type: string
description:
Release version of the application package.
components:
minItems: 1
type: array
description:
Versioned application components the package will consist
of.
items:
$ref: "#/components/schemas/ApplicationPackageCreateRequest.ApplicationComponentBuildRef"
ApplicationPackageCreateRequest.ApplicationComponentBuildRef:
required:
- componentId
- version
type: object
properties:
componentId:
minLength: 1
type: string
description:
ID of the component.
version:
type: string
description:
Release version of the component.
ApplicationPackageResponse:
required:
- components
type: object
properties:
version:
type: string
description:
Release version of the application package.
applicationId:
type: string
description:
ID of an application the package belongs to.
basePackageVersion:
type: string
description:
Version of the package this package has been based on.
nullable: true
archived:
type: boolean
description:
Indicates whether this package has been archived.
preview:
type: boolean
components:
type: array
description:
Application components the package consists of.
items:
$ref: "#/components/schemas/ApplicationPackageResponse.ComponentPackage"
labels:
type: array
description:
Optional colored labels of the package.
nullable: true
deprecated: true
items:
$ref: "#/components/schemas/ApplicationPackageResponse.Label"
resourceLabels:
type: array
description: Resource labels attached to this application package.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
createdAt:
type: string
description: |
The timestamp when the application package was created. If the timestamp is unknown, the value will be returned as `null`.
format: date-time
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the application package.
If the user is unknown, the value will be returned as `null`.
ApplicationPackageResponse.ComponentPackage:
type: object
properties:
componentId:
type: string
description:
ID of the component.
version:
type: string
description:
Version of the component.
dockerImage:
type: string
description:
Docker image of the component.
deleted:
type: boolean
description:
Indicates whether the component has been deleted.
branch:
type: string
description:
Branch the component version was build from.
nullable: true
commit:
description:
Commit the component version was build from.
nullable: true
allOf:
- $ref: "#/components/schemas/CommitInfo"
partOfBasePackage:
type: boolean
description: |-
Indicates whether the component is part of the base package.
Preview packages will have components which are not part of the base package
nullable: true
ApplicationPackageResponse.Label:
type: object
properties:
id:
type: string
description:
ID of the label.
format: uuid
text:
type: string
description:
Text of the label.
color:
type: string
description:
Color of the label.
ApplicationResponse:
required:
- id
- name
- runtimeName
- status
type: object
properties:
abilities:
type: array
description: Operations the caller may perform on this application.
items:
type: string
id:
type: string
description: The unique identifier of the application.
runtimeName:
type: string
description: |
Runtime id of the application compatible with DNS-1123 label, based on id.
It must be used in certain places such as kubernetes labels. (Might be the same as id.)
name:
type: string
description:
Human readable name of the component.
description:
type: string
description:
Description of the application.
status:
type: string
description: |
Status of the application.
READY - Application is ready to be used.
DELETING - Application is being deleted.
relatedEnvironments:
type: array
description: |
Environments related to the application.
items:
$ref: "#/components/schemas/EnvironmentMetadata"
createdAt:
type: string
description: |
The timestamp when the application was created. If the timestamp is unknown, the value will be returned as `null`.
format: date-time
nullable: true
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the application.
If the user is unknown, the value will be returned as `null`.
nullable: true
resourceLabels:
type: array
description: Labels attached to this application.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
ApplicationResponseV2:
required:
- id
- name
- runtimeName
- status
type: object
properties:
abilities:
type: array
description: Operations the caller may perform on this application.
items:
type: string
id:
type: string
description: Unique identifier of the application.
runtimeName:
type: string
description: Runtime id of the application — DNS-1123-compatible derivative
of `id`.
name:
type: string
description: Human-readable name of the application.
description:
type: string
description: Description of the application.
nullable: true
status:
type: string
description: "Lifecycle status. READY = ready to use, DELETING = deletion\
\ in progress."
productionEnvironmentId:
type: string
description: "Id of the environment treated as production, if any."
nullable: true
deploymentTargets:
description: Access policies (mode + ids) and resolved items for related
deployment targets (environments and labels). Each block exposes the configured
`mode` and the resolved `items`.
nullable: true
allOf:
- $ref: "#/components/schemas/RelatedDeploymentTargetsResponse"
createdAt:
type: string
description: Timestamp when the application was created. `null` if unknown.
format: date-time
nullable: true
createdBy:
type: string
description: Identifier of the user who created the application. `null`
if unknown.
nullable: true
resourceLabels:
type: array
description: Labels attached to this application.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
description: Application detail (v2). Related deployment targets are returned
as a composite `deploymentTargets` object describing the access policies (mode
+ ids) for both environments and labels.
ApplicationUpdateRequest:
type: object
properties:
description:
type: string
nullable: true
relatedEnvironments:
type: array
nullable: true
items:
$ref: "#/components/schemas/EnvironmentRef"
ApplicationUpdateRequestV2:
type: object
properties:
description:
type: string
description: New description for the application.
nullable: true
example: Customer-facing storefront
prodEnvironment:
type: string
description: Id of the environment to be treated as production.
nullable: true
example: prod
relatedEnvironments:
description: "Replacement access policy for related deployment environments.\
\ When present, fully replaces the existing policy."
nullable: true
allOf:
- $ref: "#/components/schemas/RelatedTargetsConfig"
relatedLabels:
description: "Replacement access policy for related deployment labels. When\
\ present, fully replaces the existing policy."
nullable: true
allOf:
- $ref: "#/components/schemas/RelatedTargetsConfig"
description: Update-application payload (v2). All fields are optional; only
the fields present in the request are updated. At least one field must be
set.
BuildState:
type: string
description: |
The status of the build
INITIALISING: The build is being initialised
WAITING: The build is waiting to be started
BUILDING: The build is in progress
BUILD_FINISHED: The build has finished
SUCCESSFUL: The build has been successful
FAILED: The build has failed
CANCELLED: The build has been cancelled
INCOMPLETE: Build is missing required CI results
LOST: The status cannot be determined
enum:
- INITIALISING
- WAITING
- BUILDING
- SUCCESSFUL
- FAILED
- CANCELLED
- LOST
- INCOMPLETE
- BUILD_FINISHED
BuildType:
type: string
description: The type of the build
enum:
- RELEASE
- PREVIEW
- PRERELEASE
x-enum-descriptions:
- "A release build, i.e. 1.0.0"
- "A preview build, unnamed version which will be directly deployed"
- "Similar to preview build, but the user has choice to name the version, i.e.\
\ 1.7.0-prerelease1"
CiResult:
required:
- payload
- type
- version
type: object
properties:
version:
type: string
description:
The version of the payload.
type:
type: string
description:
The type of the payload.
payload:
description:
The payload (data associated with CI build).
allOf:
- $ref: "#/components/schemas/PayloadItem"
CiSettings:
type: object
properties:
provider:
type: string
description: |
Associated CI provider:
codenow - uses CodeNow CI
external - uses external CI
nullable: true
availableProviders:
type: array
description: |
List of CI providers that are configurable for the application component.
nullable: true
items:
type: string
globalPipelinesConfiguration:
type: boolean
description: "
A boolean flag indicating whether pipeline settings\
\ are globally configured for the entire repository. If set to false,\
\ the pipeline settings are independently customized for individual branches."
nullable: true
CiSettings_1:
type: object
properties:
provider:
type: string
description: |
Associated CI provider:
codenow - uses CodeNow CI
external - uses external CI
nullable: true
availableProviders:
type: array
description: |
List of CI providers that are configurable for the container.
nullable: true
items:
type: string
globalPipelinesConfiguration:
type: boolean
description: "
A boolean flag indicating whether pipeline settings\
\ are globally configured for the entire repository. If set to false,\
\ the pipeline settings are independently customized for individual branches."
nullable: true
CiSettings_2:
type: object
properties:
provider:
type: string
description: |
Associated CI provider:
codenow - uses CodeNow CI
external - uses external CI
nullable: true
availableProviders:
type: array
description: |
List of CI providers that are configurable for the library.
nullable: true
items:
type: string
globalPipelinesConfiguration:
type: boolean
description: "
A boolean flag indicating whether pipeline settings\
\ are globally configured for the entire repository. If set to false,\
\ the pipeline settings are independently customized for individual branches."
nullable: true
Cluster:
required:
- createdAt
- creationStatus
- domain
- enabled
- id
- name
- primary
- readyForChanges
- requestedBy
- selfHosted
- updatedAt
- version
type: object
properties:
id:
type: string
description:
The unique identifier of the cluster.
name:
type: string
description: |
The user-friendly name or label for the cluster. It allows users to provide a clear
and descriptive name that helps in identifying and distinguishing different clusters easily.
The field accepts free text with alphanumeric and special characters.
If the displayName is not explicitly set during creation, the cluster name will
be used as the default displayName, ensuring the cluster has a recognizable and unique label.
description:
type: string
description: "
The detailed textual description of the cluster. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the cluster.
"
nullable: true
domain:
type: string
description:
The fully qualified domain name used to access the services
running in the cluster.
primary:
type: boolean
description:
A boolean flag indicating whether the cluster is the
primary (or default) cluster for the associated account.
enabled:
type: boolean
description: "
A boolean flag indicating whether the cluster is enabled\
\ for use. If set to false, the cluster is suspended and unavailable."
createdAt:
type: string
description:
The timestamp denoting when the cluster was created.
It is an automatically generated value that records the exact date and
time when the cluster was added to the system.
format: date-time
updatedAt:
type: string
description:
The timestamp denoting when the cluster was last updated.
It is an automatically generated value that records the exact date and
time when the cluster configuration was changed.
format: date-time
version:
type: string
description:
The current version of the cluster. Version can change
when the cluster configuration is updated.
creationStatus:
type: string
description:
The current life-cycle status of the cluster.
requestedBy:
type: string
description:
The username of the user who requested the creation of
the cluster.
workerNodes:
type: array
description: "
A list of objects representing the configuration of\
\ worker nodes in the cluster. Each object contains details about a specific\
\ type of worker node, including the common cloud provider and the count\
\ of nodes of that type.
"
items:
$ref: "#/components/schemas/WorkerNode"
selfHosted:
type: boolean
description: "
A boolean flag indicating whether the cluster is managed\
\ by the customer. If set to false, the cluster is registered under, and\
\ managed by, CodeNOW.
"
readyForChanges:
type: boolean
description:
A boolean flag indicating whether the cluster is ready
for reconfiguration.
CodeNowCIEndEvent:
required:
- pipelineId
- result
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: |
The type of the event.
default: codenow.ci.end.event
version:
minLength: 1
type: string
description: |
The version of the event.
default: application/vnd.codenow.v1+json
pipelineId:
minLength: 1
type: string
description: "
Correlation ID of the pipeline run, all events of the\
\ same build must have the same pipelineId.
"
createdAt:
type: string
description:
Timestamp of the event.
format: date-time
nullable: true
result:
$ref: "#/components/schemas/CodeNowCIEndEvent.PipelineResult"
description:
type: string
description:
Optional description in case of failure.
nullable: true
description: |
Event that indicates the end of a pipeline run.
Only one event of this type must be sent per pipelineId.
CodeNowCIEndEvent.PipelineResult:
type: string
description: |
The result of the pipeline.
FAILED: the builds has failed.
SUCCESSFUL: the build has succeeded.
CANCELED: the build has been canceled.
enum:
- FAILED
- SUCCESSFUL
- CANCELED
CodeNowCIEvent:
required:
- pipelineId
- type
- version
type: object
properties:
type:
type: string
description: |
The type of the event.
version:
minLength: 1
type: string
description: |
The version of the event.
pipelineId:
type: string
description: "
Correlation ID of the pipeline run, all events of the\
\ same build must have the same pipelineId.
"
createdAt:
type: string
description:
Timestamp of the event.
format: date-time
discriminator:
propertyName: type
mapping:
codenow.ci.start.event: "#/components/schemas/CodeNowCIStartEvent"
codenow.ci.end.event: "#/components/schemas/CodeNowCIEndEvent"
codenow.ci.result.event: "#/components/schemas/CodeNowCIResultEvent"
oneOf:
- $ref: "#/components/schemas/CodeNowCIStartEvent"
- $ref: "#/components/schemas/CodeNowCIResultEvent"
- $ref: "#/components/schemas/CodeNowCIEndEvent"
CodeNowCIResultEvent:
required:
- payload
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: |
The type of the event.
default: codenow.ci.result.event
version:
minLength: 1
type: string
description: |
The version of the event.
default: application/vnd.codenow.v1+json
payload:
minItems: 1
type: array
description:
The results of the CI build.
items:
$ref: "#/components/schemas/PayloadItem"
description:
Event with the results of a pipeline run. Multiply results
can be sent for the same pipelineId.
CodeNowCIStartEvent:
required:
- buildVersion
- componentId
- pipelineId
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: |
The type of the event.
default: codenow.ci.start.event
version:
minLength: 1
type: string
description: |
The version of the event.
default: application/vnd.codenow.v1+json
pipelineId:
minLength: 1
type: string
description: "
Correlation ID of the pipeline run, all events of the\
\ same build must have the same pipelineId.
"
createdAt:
type: string
description:
Timestamp of the event.
format: date-time
nullable: true
componentId:
minLength: 1
type: string
description:
CodeNOW id of the library / application component to
be build.
buildVersion:
type: string
description:
Version of the library / application component to be
build.
actor:
description:
Actor that triggered the pipeline.
nullable: true
allOf:
- $ref: "#/components/schemas/CodeNowCIStartEvent.Actor"
pipelineName:
type: string
description:
The name of the pipeline.
dashboardUrl:
type: string
description:
The URL of the dashboard where details of the build can
be accessed through the CodeNOW UI.
description: |
Event that indicates the start of a pipeline run.
Only one event of this type must be sent per pipelineId.
CodeNowCIStartEvent.Actor:
required:
- username
type: object
properties:
username:
minLength: 1
type: string
description:
The username of the actor.
fullname:
type: string
description:
The full name of the actor.
nullable: true
CodeQuality:
required:
- status
- url
type: object
properties:
url:
type: string
description:
URL to the code quality report.
status:
description:
Status of the code quality.
allOf:
- $ref: "#/components/schemas/CodeQuality.Status"
CodeQuality.Status:
type: string
enum:
- NOT_ANALYZED
- ERROR
- SUCCESSFUL
- UNKNOWN
CodeQuality_1:
required:
- system
- type
- url
- version
type: object
properties:
type:
minLength: 1
type: string
description: "
The type of the payload: code-quality"
default: code-quality
version:
minLength: 1
type: string
description: "
The version of the payload: v1
"
default: v1
system:
minLength: 1
type: string
description: "
The system used to check the code quality i.e. SonarQube,\
\ Codacy, etc.
"
url:
minLength: 1
type: string
description:
The URL to the code quality report.
description:
The code quality report.
CodenowTriggersResponse:
required:
- present
- triggers
type: object
properties:
present:
type: boolean
description: |-
A boolean flag indicating whether the configuration file .codenow.triggers.yaml
containing the trigger configuration exists in this component's repository.
If set to false, no triggers have been defined yet.
triggers:
type: array
description:
A list of objects representing all triggers currently
defined for this component.
items:
$ref: "#/components/schemas/Trigger"
CodenowTriggersResponse_1:
required:
- present
- triggers
type: object
properties:
present:
type: boolean
description: |-
A boolean flag indicating whether the configuration file .codenow.triggers.yaml
containing the trigger configuration exists in this container's repository.
If set to false, no triggers have been defined yet.
triggers:
type: array
description:
A list of objects representing all triggers currently
defined for this container.
items:
$ref: "#/components/schemas/Trigger_1"
CodenowTriggersResponse_2:
required:
- present
- triggers
type: object
properties:
present:
type: boolean
description: |-
A boolean flag indicating whether the configuration file .codenow.triggers.yaml
containing the trigger configuration exists in this library's repository.
If set to false, no triggers have been defined yet.
triggers:
type: array
description:
A list of objects representing all triggers currently
defined for this library.
items:
$ref: "#/components/schemas/Trigger_2"
CodenowTriggersUpdateRequest:
required:
- triggers
type: object
properties:
triggers:
type: array
description:
A list of objects representing all triggers currently
defined for this component.
items:
$ref: "#/components/schemas/Trigger"
CodenowTriggersUpdateRequest_1:
required:
- triggers
type: object
properties:
triggers:
type: array
description:
A list of objects representing all triggers currently
defined for this container.
items:
$ref: "#/components/schemas/Trigger_1"
CodenowTriggersUpdateRequest_2:
required:
- triggers
type: object
properties:
triggers:
type: array
description:
A list of objects representing all triggers currently
defined for this library.
items:
$ref: "#/components/schemas/Trigger_2"
CommitInfo:
type: object
properties:
id:
type: string
description:
The commit SHA.
shortId:
type: string
description:
The short commit SHA.
nullable: true
message:
type: string
description:
The commit message.
nullable: true
author:
description:
Author of the commit.
nullable: true
allOf:
- $ref: "#/components/schemas/CommitPerson"
committer:
description:
Committer of the commit.
nullable: true
allOf:
- $ref: "#/components/schemas/CommitPerson"
CommitInfo_1:
required:
- author
- committer
- id
- message
- shortId
type: object
properties:
id:
type: string
shortId:
type: string
message:
type: string
author:
$ref: "#/components/schemas/CommitPerson_1"
committer:
$ref: "#/components/schemas/CommitPerson_1"
CommitPerson:
type: object
properties:
name:
type: string
description:
The name of the person.
email:
type: string
description:
The email of the person.
date:
type: string
description:
The date of the commit.
format: date-time
CommitPerson_1:
required:
- date
- email
- name
type: object
properties:
name:
type: string
email:
type: string
date:
type: string
format: date-time
ConfigurationType:
type: string
description:
Controls which configuration will be used when deploying
PREVIEW builds .
enum:
- latest
- preview
- branch
x-enum-descriptions:
-
The latest configuration will be used.
- |
Preview configuration will be used.
Application preview configuration is anonymous, ad-hoc and temporary configuration useful for testing and previewing changes.
- |
The configuration from the branch will be used for the deployed component.
Application preview configuration for the environment will be used or created if it does not exist.
x-enum-varnames:
- latest
- preview
- branch
Connection:
required:
- name
- templateType
- type
type: object
properties:
name:
type: string
description:
The user-friendly name or label for the connection.
type:
type: string
description: |-
An internal identifier for the service scaffold, determined by the service type or brand in the case of managed services,
or by the template ID for external services.
templateType:
description: |-
The template type is closely associated with the service type and indicates whether it is a MANAGED service,
provided and maintained by CodeNOW,or EXTERNAL service, defined by the user and maintained independently outside of CodeNOW.
allOf:
- $ref: "#/components/schemas/ServiceTemplateType"
instanceId:
type: string
description: |-
The unique identifier of the specific service instance connected to the component.
The type of this service instance must match the type attribute.
ConnectionsUpdateRequest:
required:
- connections
type: object
properties:
connections:
type: array
description: |-
A list of all needed connected services, denoted by connection name, service type and a specific instance.
Providing an empty list will remove all connections.
items:
$ref: "#/components/schemas/ConnectionsUpdateRequest.ConnectionRequest"
ConnectionsUpdateRequest.ConnectionRequest:
required:
- name
- type
type: object
properties:
name:
minLength: 1
type: string
description: |-
The user-friendly name or label for the connection.
Must be unique per component, upper-case and contain no spaces (underscores are allowed).
type:
minLength: 1
type: string
description: |-
An internal identifier for the service scaffold, determined by the service type or brand in the case of managed services,
or by the template ID for external services.
instanceId:
type: string
description: |-
The unique identifier of the specific service instance that should be connected to the component.
The type of this service instance must match the type attribute.
Container:
required:
- artifactPath
- artifactVersion
- repositoryUrl
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: "
The type of the payload: container
"
default: container
version:
minLength: 1
type: string
description: "
The version of the payload: v1
"
default: v1
repositoryUrl:
minLength: 1
type: string
description:
The URL of the container repository.
artifactPath:
minLength: 1
type: string
description:
The path to the container artifact.
artifactVersion:
minLength: 1
type: string
description:
The version of the container artifact.
description:
A container artifact.
ContainerBuildLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to a container build. Provide labelId\
\ to use an existing label, or text+color to create a new one."
ContainerBuildLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from a container build
ContainerBuildRequest:
required:
- branch
- version
type: object
properties:
branch:
minLength: 1
type: string
description: |
The branch of the container to be built.
version:
maxLength: 63
minLength: 1
type: string
description: |
The version of the container to be built, ie. 1.0.0
ContainerBuildResponse:
required:
- actions
- archived
- branch
- buildType
- ciProvider
- containerId
- createdAt
- id
- pipeline
- requestedBy
- status
- version
type: object
properties:
id:
type: string
description: The unique identifier of the build.
url:
type: string
description: URL to the build's dashboard.
nullable: true
containerId:
type: string
description: The unique identifier of the container.
version:
type: string
description: The version of the container build.
buildType:
description: The type of the build.
allOf:
- $ref: "#/components/schemas/BuildType"
branch:
type: string
description: The branch from which the container build was created.
commit:
description: Commit from which the build was created.<
nullable: true
allOf:
- $ref: "#/components/schemas/CommitInfo_1"
status:
description: The status of the build.
allOf:
- $ref: "#/components/schemas/BuildState"
codeQuality:
description: |
Code Quality information
Not all pipelines will provide this information.
nullable: true
allOf:
- $ref: "#/components/schemas/CodeQuality"
requestedBy:
type: string
description: |
The user who requested the build.
createdAt:
type: string
description: The time when the builds was requested
format: date-time
archived:
type: boolean
description: |
Whether the build is archived or not.
Archived builds do not provide additional information (logs, code quality, etc.)
actions:
type: array
description: |
The list of actions that can be performed on the build.
- cancel - build can be cancelled
-
- rerun - build can be rerun (after failure or cancellation)
-
items:
type: string
pipeline:
type: string
description: |
The pipeline used to create the build.
errorMessage:
type: string
description: |
The error message if the build failed.
nullable: true
results:
type: array
description: |
CI results associated with the build
.
nullable: true
items:
$ref: "#/components/schemas/CiResult"
ciProvider:
type: string
description: |
The CI provider used to create the build.
resourceLabels:
type: array
description: Labels attached to this build.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
ContainerCiConfigResponse:
required:
- build
type: object
properties:
build:
description: |
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.
allOf:
- $ref: "#/components/schemas/ContainerCiConfigResponse.Build"
ContainerCiConfigResponse.Build:
required:
- pipelines
type: object
properties:
environmentVariables:
type: array
description: |
The environmentVariables section configures custom environment variables
that are utilized within the Continuous Integration (CI) pipeline.
nullable: true
items:
$ref: "#/components/schemas/ContainerCiConfigResponse.Build.EnvironmentVariable"
pipelines:
description: |
The pipelines section defines and configures the specific pipelines
to be executed for release builds and preview builds.
allOf:
- $ref: "#/components/schemas/ContainerCiConfigResponse.Build.Pipelines"
ContainerCiConfigResponse.Build.EnvironmentVariable:
required:
- name
- value
type: object
properties:
name:
type: string
description:
The name of the environment variable.
value:
type: string
description:
The value of the environment variable.
ContainerCiConfigResponse.Build.Pipelines:
required:
- release
type: object
properties:
release:
type: string
description: |
Defines the pipeline id for performed release builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.
ContainerCiConfigSettingsResponse:
required:
- globalPipelinesConfiguration
type: object
properties:
globalPipelinesConfiguration:
type: boolean
description: "
A boolean flag indicating whether pipeline settings\
\ are globally configured for the entire repository. If set to false,\
\ the pipeline settings are independently customized for individual branches."
ContainerCiConfigSettingsUpdateRequest:
required:
- globalPipelinesConfiguration
type: object
properties:
globalPipelinesConfiguration:
type: boolean
description: "
A boolean flag indicating whether pipeline settings\
\ are globally configured for the entire repository. If set to false,\
\ the pipeline settings are independently customized for individual branches."
ContainerCiConfigUpdateRequest:
type: object
properties:
build:
description: |
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.
nullable: true
allOf:
- $ref: "#/components/schemas/ContainerCiConfigUpdateRequest.Build"
ContainerCiConfigUpdateRequest.Build:
type: object
properties:
environmentVariables:
type: array
description: |
The environmentVariables section configures custom environment variables
that are utilized within the Continuous Integration (CI) pipeline.
nullable: true
items:
$ref: "#/components/schemas/ContainerCiConfigUpdateRequest.Build.EnvironmentVariable"
pipelines:
description: |
The pipelines section defines and configures the specific pipelines
to be executed for release builds and preview builds.
nullable: true
allOf:
- $ref: "#/components/schemas/ContainerCiConfigUpdateRequest.Build.Pipelines"
ContainerCiConfigUpdateRequest.Build.EnvironmentVariable:
required:
- name
- value
type: object
properties:
name:
minLength: 1
type: string
description:
The name of the environment variable.
value:
minLength: 1
type: string
description:
The value of the environment variable.
ContainerCiConfigUpdateRequest.Build.Pipelines:
required:
- release
type: object
properties:
release:
type: string
description: |
Defines the pipeline id for performed release builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.
ContainerComponentResponse:
required:
- ciSettings
- id
- name
- scm
- settings
- state
type: object
properties:
id:
type: string
description:
The unique identifier of the container. Based on the
user-defined container name.
name:
type: string
description:
The user-friendly name of the container. It allows users
to provide a clear and descriptive name that helps in identifying and
distinguishing different containers easily. The field accepts free text
with alphanumeric and special characters.
description:
type: string
description: "
The detailed textual description of the container. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the container.
"
nullable: true
state:
description:
The current life-cycle status of the container.
allOf:
- $ref: "#/components/schemas/ContainerState"
error:
description: "
Error details, if any, encountered during the container\
\ creation process.
"
nullable: true
allOf:
- $ref: "#/components/schemas/ErrorSpec"
scm:
description: "
An object containing Source Code Management (SCM) information,\
\ including provider, repository/project ID, HTTP clone URL, and SSH clone\
\ URL.
"
allOf:
- $ref: "#/components/schemas/ScmSpec_1"
settings:
description: |
Basic settings for the container
allOf:
- $ref: "#/components/schemas/Settings_1"
ciSettings:
description: |
CI settings for the container
allOf:
- $ref: "#/components/schemas/CiSettings_1"
createdAt:
type: string
description: |
The timestamp when the container was created. If the timestamp is unknown, the value will be returned as `null`.
format: date-time
nullable: true
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the container.
If the user is unknown, the value will be returned as `null`.
nullable: true
resourceLabels:
type: array
description: Labels attached to this container.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
ContainerCreateRequest:
required:
- name
- scm
type: object
properties:
name:
maxLength: 170
minLength: 3
type: string
description: |-
Human readable name of the container.
CodeNOW will generate an ID for the container based on this name.
description:
type: string
description: "
The detailed textual description of the container. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the container.
"
nullable: true
scm:
description: |-
Defines the repository in SCM.
Supported providers/actions can be obtained through the /scm/providers endpoint.
allOf:
- $ref: "#/components/schemas/ContainerCreateRequest.Scm"
description: Container specification
ContainerCreateRequest.Scm:
required:
- action
- existingRepository
- monoRepository
- providerId
- providerType
- spaceId
type: object
properties:
action:
description:
Action that will be performed on the SCM repository.
allOf:
- $ref: "#/components/schemas/ActionType"
default: CREATE
providerId:
minLength: 1
type: string
description: |
Instance ID of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
providerType:
minLength: 1
type: string
description: |
Type of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
existingRepository:
type: boolean
description: |
Defines if the new container will be created in existing repository:
- true: you must define spaceId and repositoryId of the existing repository in the request
- false: new repository will be created for the component
monoRepository:
type: boolean
description: |
Defines if the new container will be share repository with other components:
- true: you must define componentPath where the container will be hosted in the repository
- false: the container will be hosted in the root of the repository
componentPath:
pattern: "^[a-zA-Z0-9\\-_~./]*$"
type: string
description: |
Define path in the repository where the container will be placed.
nullable: true
spaceId:
type: string
description: |
ID of an existing SCM spaces where repository will be hosted.
Available repositories can be obtained through the /scm/provider/{providerType}/{providerId}/spaces endpoint.
repositoryId:
type: string
description: |
ID of an existing SCM repository to which the container should be placed.
Available repositories can be obtained through the /scm/provider/{providerType}/{providerId}/spaces/{spaceId}/repos endpoint.
nullable: true
ContainerCreateResponse:
required:
- displayName
- id
- state
- templateId
type: object
properties:
id:
type: string
description:
The unique identifier of the container. Based on the
user-defined container name.
displayName:
type: string
description:
The user-friendly name or label for the container. It
allows users to provide a clear and descriptive name that helps in identifying
and distinguishing different containers easily. The field accepts free
text with alphanumeric and special characters.
description:
type: string
description: "
The detailed textual description of the container. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the container.
"
nullable: true
templateId:
type: string
description: "
An internal identifier of the scaffold selected for\
\ container creation. It includes information about the selected language,\
\ build tool and framework, if specified.
"
state:
description:
The current life-cycle status of the container.
allOf:
- $ref: "#/components/schemas/ContainerState"
ContainerLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to a container. Provide labelId to use\
\ an existing label, or text+color to create a new one."
ContainerLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from a container
ContainerRelease:
required:
- containerId
- version
type: object
properties:
containerId:
minLength: 1
type: string
description:
Unique identifier of the container.
version:
minLength: 1
type: string
description:
Version number.
ContainerState:
type: string
description: |
State of the container
CREATING - Container is being created
READY - Container is ready
FAILED - Container creation failed
DELETING - Container is being deleted
enum:
- CREATING
- READY
- FAILED
- DELETING
ContainerUpdateRequest:
type: object
properties:
description:
type: string
description: "
The detailed textual description of the container. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the container.
"
nullable: true
maxQueueSize:
maximum: 30
minimum: 2
type: integer
description: |-
The maximum number of builds that will be kept in the queue. Older builds will be archived.
This field is optional. If provided, it must be a value between 2 and 30.
format: int32
nullable: true
ciSettings:
description: "
The CI settings for the container. If provided, the\
\ CI settings will be updated.
"
nullable: true
allOf:
- $ref: "#/components/schemas/CiSettings_1"
description: Updated container specification
DefaultPipelineType:
type: string
description: |
The parameter specifies default CI pipelines for component type:
`app`: default CI pipelines for application components
`lib`: default CI pipelines for libraries
enum:
- app
- lib
x-enum-varnames:
- app
- lib
DefaultPipelines:
required:
- preview
- release
type: object
properties:
release:
type: array
description:
List of default release CI pipelines.
items:
type: string
preview:
type: array
description:
List of default preview CI pipelines.
items:
type: string
Deployment:
required:
- configurationVersion
- createdAt
- id
- remoteDebug
- status
- version
type: object
properties:
id:
type: string
description: Internal identifier of the deployment.
example: c3a74a8d-9a52-4d4f-9a0e-bd0b3f3c9e02
status:
type: string
description: Current runtime status of the deployment.
example: HEALTHY
dashboardUrl:
type: string
description: "URL of the deployment dashboard (ArgoCD or equivalent), when\
\ available."
nullable: true
example: https://argocd.example.com/applications/my-app
version:
minLength: 1
type: string
description: Application package version actually deployed.
example: 1.4.0
configurationVersion:
minLength: 1
type: string
description: Deployment configuration version resolved for this deployment.
example: "1.4"
error:
description: Error detail if the last deployment attempt failed.
nullable: true
allOf:
- $ref: "#/components/schemas/DeploymentError"
packageLabels:
type: array
description: Labels attached to the underlying application package. Only
present when the `packageLabels` expand is requested.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
createdAt:
type: string
description: Timestamp the deployment was created.
format: date-time
nullable: true
example: 2026-04-20T11:42:00Z
createdBy:
type: string
description: Identifier of the user who created the deployment.
nullable: true
example: alice@acme.com
remoteDebug:
type: boolean
description: Whether remote debugging is enabled on this deployment.
description: Currently deployed application instance on a specific environment.
DeploymentAction:
type: string
description: Action being performed by a pending deployment.
enum:
- DEPLOY
- UNDEPLOY
DeploymentEnvironmentsResponse:
type: object
properties:
environmentsMode:
description: Mode of the application's environment policy.
allOf:
- $ref: "#/components/schemas/RelatedTargetMode"
labelsMode:
description: Mode of the application's label policy. Populated only when
expand=labelEnvironments.
nullable: true
allOf:
- $ref: "#/components/schemas/RelatedTargetMode"
items:
type: array
description: Effective environments. Each item carries a `source` marker
(DIRECT or LABEL); direct entries shadow label-resolved entries with the
same id.
items:
$ref: "#/components/schemas/RelatedDeploymentTargetsResponse.EnvironmentItem"
description: |-
Effective set of deployment environments for an application. Contains environments matched by the
application's direct environment policy and, when `expand=labelEnvironments`, additional environments
resolved from the application's label policy. When an environment is matched by both policies,
the direct one wins (`source=DIRECT`).
DeploymentError:
type: object
properties:
code:
type: string
description: Machine-readable error code.
nullable: true
example: APPLICATION_DEPLOYMENT_ARTIFACT_DOWNLOAD_ERROR
message:
type: string
description: Human-readable error message.
nullable: true
example: Failed to download application artifact
description: "Error detail recorded on a failed deployment, if any."
DeploymentJobRun:
required:
- jobRunId
- jobStatus
- requestedAt
- requestedBy
- taskGroupId
- taskGroupStatus
type: object
properties:
applicationVersion:
type: string
description: Application version the job is deploying.
example: 1.4.0
jobRunId:
type: string
description: Identifier of the job run.
example: 7f9c2e10-3d4a-4c1e-9a42-2b5c8f0e9b1d
jobStatus:
description: Status of the job run.
allOf:
- $ref: "#/components/schemas/JobRunStatus"
taskGroupId:
type: string
description: Identifier of the owning task group.
example: tg-6c0b1d3a
taskGroupStatus:
description: Status of the owning task group.
allOf:
- $ref: "#/components/schemas/TaskGroupStatus"
requestedAt:
type: string
description: Timestamp the job was requested.
format: date-time
example: 2026-04-20T11:42:00Z
requestedBy:
type: string
description: Identifier of the user who requested the deployment.
example: alice@acme.com
description: "Reference to an in-flight deployment job run. Note: a null `jobRun`\
\ on the enclosing response does NOT mean \"no job ever ran\" — it means \"\
no active job right now\"; completed task groups are filtered out. `jobRun`\
\ and `pendingDeployment` are eventually consistent; treat the pair as a snapshot."
DeploymentStatus:
type: string
description: |
The status of the deployment.
- REQUESTED: The deployment has been requested.
- HEALTHY: The deployment is healthy.
- PROGRESSING: The deployment is in progress.
- DEGRADED: The deployment is degraded.
- MISSING: The deployment is incomplete / missing some parts.
- UNKNOWN: The deployment status is unknown.
- WARNING: The deployment has a warning.
- NOT_DEPLOYED: The deployment is not deployed.
- DELETING: The deployment is being deleted.
- FAILED_TO_CREATE: The deployment failed to be created.
- FAILED_TO_UPDATE: The deployment failed to be updated.
- UPDATING: The deployment is being updated.
enum:
- REQUESTED
- HEALTHY
- PROGRESSING
- DEGRADED
- MISSING
- UNKNOWN
- WARNING
- NOT_DEPLOYED
- DELETING
- FAILED_TO_CREATE
- FAILED_TO_UPDATE
- UPDATING
Deployment_1:
required:
- configurationType
- environmentId
type: object
properties:
environmentId:
minLength: 1
type: string
description:
Target environment for the deployment
configurationType:
description:
Controls which configuration will be used for the deployment
allOf:
- $ref: "#/components/schemas/ConfigurationType"
default: latest
DetailedLabelResponse:
required:
- color
- id
- text
type: object
properties:
id:
type: string
description: Unique identifier of the label
example: 550e8400-e29b-41d4-a716-446655440000
text:
type: string
description: Display text of the label
example: Production Ready
color:
type: string
description: Hex color code for the label
example: "#FF5733"
createdAt:
type: string
description: When the label was created
format: date-time
nullable: true
updatedAt:
type: string
description: When the label was last updated
format: date-time
nullable: true
createdBy:
type: string
description: Who created the label
nullable: true
example: john.doe
description:
type: string
description: Description of the label
nullable: true
attachedResources:
type: array
description: List of resources attached to this label
items:
$ref: "#/components/schemas/ResourceReference"
description: Detailed label information including attached resources
EndpointType:
type: string
description: |
Type of endpoint
INTERNAL - Endpoint where your component is reachable internally within the cluster.
EXTERNAL - Endpoint at which your component can be reached externally.
enum:
- INTERNAL
- EXTERNAL
- UNKNOWN
Environment:
required:
- allowTriggerDeployment
- createdAt
- customerClusterId
- displayName
- id
type: object
properties:
id:
type: string
description:
The user-defined identifier for the environment. It allows
users to assign a custom and unique ID to the environment during the creation
process.
displayName:
type: string
description: |-
The user-friendly name or label for the environment. It allows users to provide a clear
and descriptive name that helps in identifying and distinguishing different environments easily.
The field accepts free text with alphanumeric and special characters.
If the displayName is not explicitly set during creation, the system will
automatically use the Environment ID as the default displayName,
ensuring the environment has a recognizable and unique name.
description:
type: string
description: |
The detailed textual description of the environment. It allows users to add additional context,
notes, or any relevant information about the purpose, usage, or characteristics of the environment.
nullable: true
customerClusterId:
type: string
description: |
The unique identifier of the cluster where the environment will be placed.
To obtain this identifier, use the GET /clusters operation to retrieve a list of available clusters.
errorCode:
type: string
nullable: true
errorMessage:
type: string
nullable: true
createdAt:
type: string
description: |-
The timestamp when the environment was created. It is an automatically generated value that
records the exact date and time when the environment was added to the system.
format: date-time
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the environment.
If the user is unknown, the value will be returned as `null`.
nullable: true
status:
description: |-
Expandable with query value expand=status
Current runtime status of the environment
allOf:
- $ref: "#/components/schemas/EnvironmentStatus"
hasDeployment:
type: boolean
description: |
Expandable with query value expand=deployments
Indicates whether there are any deployments associated with the environment.
If set to true, there are active or completed deployments within this environment. If set to false,
no deployments have taken place in this environment.
allowTriggerDeployment:
type: boolean
description: "
A boolean flag indicating whether the environment can\
\ be targeted by Continuous Integration (CI) triggers for automated deployments.\
\ If set to true, CI triggers are allowed to deploy changes\
\ to this environment automatically. If set to false, CI\
\ triggers are disabled for this environment, and manual intervention\
\ is required for deployments.
"
resourceLabels:
type: array
description: Labels attached to this environment.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
effectivePermissions:
type: array
description: |
Effective user permissions.
items:
type: string
EnvironmentCreateRequest:
required:
- customerClusterId
- name
type: object
properties:
name:
maxLength: 30
minLength: 3
type: string
description:
The user-defined identifier for the environment. It allows
users to assign a custom and unique ID to the environment during the creation
process.
customerClusterId:
type: string
description: "
The unique identifier of the cluster where the environment\
\ will be placed. To obtain this identifier, use the GET /clusters\
\ operation to retrieve a list of available clusters.
"
description:
type: string
description: "
The detailed textual description of the environment.\
\ It allows users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the environment."
nullable: true
allowTriggerDeployment:
type: boolean
description: "
A boolean flag that determines whether the environment\
\ can be targeted by Continuous Integration (CI) triggers for automated\
\ deployments. When set to true, CI triggers are allowed\
\ to deploy changes to this environment automatically. When set to false,\
\ CI triggers are disabled for this environment, and manual intervention\
\ is required for deployments.
"
nullable: true
default: false
description: Environment's specification
EnvironmentLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to an environment. Provide labelId to\
\ use an existing label, or text+color to create a new one."
EnvironmentLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from an environment
EnvironmentMetadata:
required:
- id
type: object
properties:
id:
type: string
description: |
Unique environment ID.
displayName:
type: string
description:
Human readable name of the environment.
production:
type: boolean
EnvironmentRef:
type: object
properties:
id:
type: string
production:
type: boolean
EnvironmentStatus:
type: string
description: |
Status of the environment.
READY - Environment is ready to be used.
CREATING - Environment is in the process of being created.
DOWN - Environment is down / not usable.
DELETING - Environment is in the process of being deleted.
FAILED_TO_CREATE - Environment creation has failed.
UNKNOWN - Environment status is unknown.
enum:
- READY
- CREATING
- DOWN
- DELETING
- FAILED_TO_CREATE
- UNKNOWN
ErrorSpec:
type: object
properties:
code:
type: string
message:
type: string
Expand:
type: string
enum:
- labels
- components
x-enum-descriptions:
- Expand labels
- Expand components
x-enum-varnames:
- labels
- components
x-deprecated:
- labels
Expand_1:
type: string
description: |
The expand parameter allows you to specify which fields will be included in the response.
The expand parameter takes a comma-separated list of fields.
results: include CI results in the response
enum:
- results
x-enum-varnames:
- results
Expand_2:
type: string
enum:
- status
- deployments
x-enum-descriptions:
- Include status information
- Include deployments information
x-enum-varnames:
- status
- deployments
GetSpacesResponse:
required:
- name
- spaceId
- type
type: object
properties:
name:
type: string
description:
Name of the SCM space.
type:
type: string
description:
Type of the SCM space. It depends on the type of the SCM
provider.
spaceId:
type: string
description:
ID of the SCM space
GitRevision:
required:
- branch
- commitSha
- repositoryUrl
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: "
The type of the payload: git-revision"
default: git-revision
version:
minLength: 1
type: string
description: "
The version of the payload: v1
"
default: v1
repositoryUrl:
minLength: 1
type: string
description:
The URL of the repository.
branch:
minLength: 1
type: string
description:
The branch from which being built.
commitSha:
minLength: 1
type: string
description:
The commit SHA which is being built.
description:
The Git Revision information.
GitTag:
required:
- tag
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: "
The type of the payload: git-tag
"
default: git-tag
version:
minLength: 1
type: string
description: "
The version of the payload: v1
"
default: v1
tag:
minLength: 1
type: string
description:
The tag of the git repository created by the build.
description:
The tag of the git repository created by the build.
Helm:
required:
- artifactPath
- artifactVersion
- repositoryUrl
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: "
The type of the payload: helm
"
default: helm
version:
minLength: 1
type: string
description: "
The version of the payload: v1
"
default: v1
repositoryUrl:
minLength: 1
type: string
description:
The URL of the repository where the artifact is stored.
artifactPath:
minLength: 1
type: string
description:
The path to the artifact.
artifactVersion:
minLength: 1
type: string
description:
The version of the artifact.
description:
Helm chart artifact created by the build.
IdentityRef:
required:
- id
- type
type: object
properties:
id:
type: string
description: Unique identifier of the identity.
example: 5d4f9b92-1f8e-4e57-8d1a-8b3e1a4d8e72
type:
description: Type of identity.
allOf:
- $ref: "#/components/schemas/IdentityRef.Type"
description: "Reference to a user or team identity, e.g. a potential approver\
\ of a pending deployment."
IdentityRef.Type:
type: string
enum:
- USER
- TEAM
Interval:
required:
- endVersion
- startVersion
type: object
properties:
startVersion:
type: string
description:
The lowest application package version this configuration
is applicable to.
endVersion:
type: string
description:
The highest application package version this configuration
is currently applicable to. It might change with the creation and deletion
of application packages and deployment configurations.
JobQueueResponse:
required:
- accountId
- jobRunId
- status
type: object
properties:
jobRunId:
type: string
description: Identifier of the queued job run.
example: 7f9c2e10-3d4a-4c1e-9a42-2b5c8f0e9b1d
accountId:
type: string
description: Account that owns the job run.
example: acme
status:
type: string
description: Initial status of the queued job.
example: PENDING
description: Reference to the queued deployment job. Progress is observed via
the deployment list/detail endpoints (`jobRun` expansion).
JobRunStatus:
type: string
description: Lifecycle status of a deployment job run as reported by the job
controller.
enum:
- COMPLETED
- FAILED
- IN_PROGRESS
- PENDING
- CANCELLED
- RETRYING
LabelBriefResponse:
required:
- color
- id
- text
type: object
properties:
id:
type: string
description: Unique identifier of the label
example: 550e8400-e29b-41d4-a716-446655440000
text:
type: string
description: Display text of the label
example: Production Ready
color:
type: string
description: Hex color code for the label
example: "#FF5733"
description: "Brief label information with id, text, and color"
LabelCreateRequest:
required:
- color
- text
type: object
properties:
text:
maxLength: 100
minLength: 1
type: string
description: Display text of the label
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
minLength: 1
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Hex color code for the label
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description:
maxLength: 512
type: string
description: Description of the label
nullable: true
example: This label marks production-ready components
x-size-message: Label description must not exceed 512 characters
description: Request to create a new label and optionally attach it to resources
LabelMultiRequest:
type: object
properties:
attachTo:
type: array
description: List of resources to attach to the label
nullable: true
items:
$ref: "#/components/schemas/ResourceReferenceRequest"
detachFrom:
type: array
description: List of resources to detach from the label
nullable: true
items:
$ref: "#/components/schemas/ResourceReferenceRequest"
description: Request for bulk attach/detach of resources to/from a label
LabelMultiResponse:
required:
- jobRunId
- status
type: object
properties:
jobRunId:
type: string
description: ID of the queued job
example: job-550e8400-e29b-41d4
status:
type: string
description: Status of the queued job
example: QUEUED
description: Response for bulk label attach/detach operation
LabelResourceType:
type: string
enum:
- APPLICATION
- APPLICATION_COMPONENT
- APPLICATION_COMPONENT_BUILD
- APPLICATION_BUILD
- CONTAINER
- CONTAINER_BUILD
- LIBRARY
- LIBRARY_BUILD
- ENVIRONMENT
- MANAGED_COMPONENT
- EXTERNAL_SERVICE
- EXTERNAL_SERVICE_TEMPLATE
- CUSTOM_APPLICATION_COMPONENT_TEMPLATE
- CUSTOM_LIBRARY_TEMPLATE
- CUSTOM_DOMAIN
LabelResponse:
required:
- color
- id
- text
type: object
properties:
id:
type: string
description: Unique identifier of the label
example: 550e8400-e29b-41d4-a716-446655440000
text:
type: string
description: Display text of the label
example: Production Ready
color:
type: string
description: Hex color code for the label
example: "#FF5733"
createdAt:
type: string
description: When the label was created
format: date-time
nullable: true
updatedAt:
type: string
description: When the label was last updated
format: date-time
nullable: true
createdBy:
type: string
description: Who created the label
nullable: true
example: john.doe
description:
type: string
description: Description of the label
nullable: true
example: This label marks production-ready components
description: Label information
LabelUpdateRequest:
type: object
properties:
text:
maxLength: 100
minLength: 1
type: string
description: New display text of the label
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: New hex color code for the label
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description:
maxLength: 512
type: string
description: New description of the label
nullable: true
x-size-message: Label description must not exceed 512 characters
description: Request to update an existing label. Only provided fields will
be updated.
LibraryBuildLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to a library build. Provide labelId\
\ to use an existing label, or text+color to create a new one."
LibraryBuildLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from a library build
LibraryBuildRequest:
required:
- branch
- version
type: object
properties:
branch:
minLength: 1
type: string
description: |
The branch of the library to be built.
version:
maxLength: 63
minLength: 1
type: string
description: |
The version of the library to be built, ie. 1.0.0
LibraryBuildResponse:
required:
- branch
- createdAt
- id
- libraryId
- requestedBy
- status
- version
type: object
properties:
id:
type: string
description: The unique identifier of the build.
url:
type: string
description: URL to the build's dashboard.
libraryId:
type: string
description: The unique identifier of the library.
version:
type: string
description: The version of the library build.
buildType:
description: The type of the build.
allOf:
- $ref: "#/components/schemas/BuildType"
branch:
type: string
description: The branch from which the library build was created.
commit:
description: Commit from which the build was created.<
nullable: true
allOf:
- $ref: "#/components/schemas/CommitInfo_1"
status:
description: The status of the build.
allOf:
- $ref: "#/components/schemas/BuildState"
codeQuality:
description: |
Code Quality information
Not all pipelines will provide this information.
nullable: true
allOf:
- $ref: "#/components/schemas/CodeQuality"
requestedBy:
type: string
description: |
The user who requested the build.
createdAt:
type: string
description: The time when the builds was requested
format: date-time
archived:
type: boolean
description: |
Whether the build is archived or not.
Archived builds do not provide additional information (logs, code quality, etc.)
actions:
type: array
description: |
The list of actions that can be performed on the build.
- cancel - build can be cancelled
-
- rerun - build can be rerun (after failure or cancellation)
-
items:
type: string
pipeline:
type: string
description: |
The pipeline used to create the build.
errorMessage:
type: string
description: |
The error message if the build failed.
nullable: true
results:
type: array
description: |
CI results associated with the build
.
nullable: true
items:
$ref: "#/components/schemas/CiResult"
ciProvider:
type: string
description: |
The CI provider used to create the build.
resourceLabels:
type: array
description: Labels attached to this build.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
LibraryCiConfigResponse:
required:
- build
type: object
properties:
build:
description: |
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.
allOf:
- $ref: "#/components/schemas/LibraryCiConfigResponse.Build"
LibraryCiConfigResponse.Build:
required:
- environmentVariables
- image
- pipelines
type: object
properties:
image:
type: string
description: |
The field specifies the container utilized for executing build
and unit test tasks within the Continuous Integration (CI) pipeline.
environmentVariables:
type: array
description: |
The environmentVariables section configures custom environment variables
that are utilized within the Continuous Integration (CI) pipeline.
items:
$ref: "#/components/schemas/LibraryCiConfigResponse.Build.EnvironmentVariable"
pipelines:
description: |
The pipelines section defines and configures the specific pipelines
to be executed for release builds and preview builds.
allOf:
- $ref: "#/components/schemas/LibraryCiConfigResponse.Build.Pipelines"
LibraryCiConfigResponse.Build.EnvironmentVariable:
required:
- name
- value
type: object
properties:
name:
type: string
description:
The name of the environment variable.
value:
type: string
description:
The value of the environment variable.
LibraryCiConfigResponse.Build.Pipelines:
required:
- release
type: object
properties:
release:
type: string
description: |
Defines the pipeline id for performed release builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.
LibraryCiConfigSettingsResponse:
required:
- globalPipelinesConfiguration
type: object
properties:
globalPipelinesConfiguration:
type: boolean
description: "
A boolean flag indicating whether pipeline settings\
\ are globally configured for the entire repository. If set to false,\
\ the pipeline settings are independently customized for individual branches."
LibraryCiConfigSettingsUpdateRequest:
required:
- globalPipelinesConfiguration
type: object
properties:
globalPipelinesConfiguration:
type: boolean
description: "
A boolean flag indicating whether pipeline settings\
\ are globally configured for the entire repository. If set to false,\
\ the pipeline settings are independently customized for individual branches."
LibraryCiConfigUpdateRequest:
type: object
properties:
build:
description: |
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.
allOf:
- $ref: "#/components/schemas/LibraryCiConfigUpdateRequest.Build"
LibraryCiConfigUpdateRequest.Build:
type: object
properties:
image:
type: string
description: |
The field specifies the container utilized for executing build
and unit test tasks within the Continuous Integration (CI) pipeline.
nullable: true
environmentVariables:
type: array
description: |
The environmentVariables section configures custom environment variables
that are utilized within the Continuous Integration (CI) pipeline.
nullable: true
items:
$ref: "#/components/schemas/LibraryCiConfigUpdateRequest.Build.EnvironmentVariable"
pipelines:
description: |
The pipelines section defines and configures the specific pipelines
to be executed for release builds and preview builds.
nullable: true
allOf:
- $ref: "#/components/schemas/LibraryCiConfigUpdateRequest.Build.Pipelines"
LibraryCiConfigUpdateRequest.Build.EnvironmentVariable:
required:
- name
- value
type: object
properties:
name:
minLength: 1
type: string
description:
The name of the environment variable.
value:
minLength: 1
type: string
description:
The value of the environment variable.
LibraryCiConfigUpdateRequest.Build.Pipelines:
required:
- release
type: object
properties:
release:
type: string
description: |
Defines the pipeline id for performed release builds.
Available pipelines can be obtained through the /ci-pipelines endpoint.
LibraryComponentResponse:
required:
- ciSettings
- id
- name
- scm
- settings
- state
- template
type: object
properties:
id:
type: string
description:
The unique identifier of the library. Based on the user-defined
library name.
name:
type: string
description:
The user-friendly name of the library. It allows users
to provide a clear and descriptive name that helps in identifying and
distinguishing different libraries easily. The field accepts free text
with alphanumeric and special characters.
description:
type: string
description: "
The detailed textual description of the library. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the library.
"
nullable: true
state:
description:
The current life-cycle status of the library.
allOf:
- $ref: "#/components/schemas/LibraryState"
buildSystem:
type: string
description: "
The name of the build system used for compiling, testing,\
\ and packaging code within the library.
"
nullable: true
error:
description: "
Error details, if any, encountered during the library\
\ creation process.
"
nullable: true
allOf:
- $ref: "#/components/schemas/ErrorSpec"
scm:
description: "
An object containing Source Code Management (SCM) information,\
\ including provider, repository/project ID, HTTP clone URL, and SSH clone\
\ URL.
"
allOf:
- $ref: "#/components/schemas/ScmSpec_2"
template:
description:
Template specification for the library.
allOf:
- $ref: "#/components/schemas/TemplateSpec"
settings:
description: |
Basic settings for the component
allOf:
- $ref: "#/components/schemas/Settings_2"
ciSettings:
description: |
CI settings for the component
allOf:
- $ref: "#/components/schemas/CiSettings_2"
createdAt:
type: string
description: |
The timestamp when the library was created. If the timestamp is unknown, the value will be returned as `null`.
format: date-time
nullable: true
createdBy:
type: string
description: |
This field represents the identifier of the user responsible for creating the library.
If the user is unknown, the value will be returned as `null`.
nullable: true
resourceLabels:
type: array
description: Labels attached to this library.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
LibraryCreateRequest:
required:
- name
- scm
- template
type: object
properties:
name:
maxLength: 170
minLength: 3
type: string
description: |-
Human readable name of the component.
CodeNOW will generate an ID for the library based on this name.
description:
type: string
description: "
The detailed textual description of the library. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the library.
"
template:
description: |
Defines the template used for scaffolding the library.
Example:
1) List available templates at /templates/libraries endpoint and choose the one desired.
2) Depending on the template, it may be necessary to attach required/optional properties in the request body. For example, a template property defined as:
```json
"properties": [
{
"name": "groupId",
"description": "Base Java package",
"type": "string",
"required": true
}
]
```
is mandatory and will be used like this:
```json
"properties": {
"groupId": "com.example"
}
```
3) Assemble and send final request, for example:
```json
{
"name": "example-lib1",
"description": "example-lib1",
"scm": {
"actionType": "CREATE",
"provider": "codenow"
},
"template": {
"id": "java-maven-library",
"version": "3.1.0",
"properties": {
"groupId": "com.example"
}
}
}
```
4) Any omitted optional parameters will be replaced with default values.
allOf:
- $ref: "#/components/schemas/TemplateSpec"
scm:
description: |-
Defines the repository in SCM.
Supported providers/actions can be obtained through the /scm/providers endpoint.
allOf:
- $ref: "#/components/schemas/LibraryCreateRequest.Scm"
description: Library specification
deprecated: true
LibraryCreateRequest.Scm:
required:
- action
- provider
type: object
properties:
action:
description:
Action that will be performed on the SCM repository.
allOf:
- $ref: "#/components/schemas/ActionType"
default: CREATE
provider:
minLength: 1
type: string
description: |
Instance ID of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
If in doubt use "action": "CREATE", "provider": "codenow"
repositoryId:
type: string
description: |-
ID of an existing SCM repository to which the component should be linked.
It is only required for the LINK ActionType.
nullable: true
LibraryCreateRequestV2:
required:
- name
- scm
- template
type: object
properties:
name:
maxLength: 170
minLength: 3
type: string
description: |-
Human readable name of the component.
CodeNOW will generate an ID for the library based on this name.
description:
type: string
description: "
The detailed textual description of the library. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the library.
"
template:
description: |
Defines the template used for scaffolding the library.
Example:
1) List available templates at /templates/libraries endpoint and choose the one desired.
2) Depending on the template, it may be necessary to attach required/optional properties in the request body. For example, a template property defined as:
```json
"properties": [
{
"name": "groupId",
"description": "Base Java package",
"type": "string",
"required": true
}
]
```
is mandatory and will be used like this:
```json
"properties": {
"groupId": "com.example"
}
```
3) Assemble and send final request, for example:
```json
{
"name": "example-lib1",
"description": "example-lib1",
"scm": {
"action": "CREATE",
"providerId": "codenow",
"providerType": "codenow",
"existingRepository": false,
"monoRepository": false,
"spaceId": "codenow"
},
"template": {
"id": "java-maven-library",
"version": "3.1.0",
"custom": false,
"properties": {
"groupId": "com.example"
}
}
}
```
4) Any omitted optional parameters will be replaced with default values.
allOf:
- $ref: "#/components/schemas/TemplateSpecV2"
scm:
description: |-
Defines the repository in SCM.
Supported providers/actions can be obtained through the /scm/providers endpoint.
allOf:
- $ref: "#/components/schemas/LibraryCreateRequestV2.Scm"
description: Library specification
LibraryCreateRequestV2.Scm:
required:
- action
- existingRepository
- monoRepository
- providerId
- providerType
- spaceId
type: object
properties:
action:
description:
Action that will be performed on the SCM repository.
allOf:
- $ref: "#/components/schemas/ActionType"
default: CREATE
providerId:
minLength: 1
type: string
description: |
Instance ID of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
providerType:
minLength: 1
type: string
description: |
Type of an existing SCM provider
Available providers and supported actions can be obtained through the /scm/providers endpoint.
existingRepository:
type: boolean
description: |
Defines if the new component will be created in existing repository:
- true: you must define spaceId and repositoryId of the existing repository in the request
- false: new repository will be created for the component
monoRepository:
type: boolean
description: |
Defines if the new component will be share repository with other components:
- true: you must define componentPath where the component will be hosted in the repository
- false: the component will be hosted in the root of the repository
componentPath:
pattern: "^[a-zA-Z0-9\\-_~./]*$"
type: string
description: |
Define path in the repository where the component will be placed.
nullable: true
spaceId:
type: string
description: |
ID of an existing SCM spaces where repository will be hosted.
Available repositories can be obtained through the /scm/provider/{providerType}/{providerId}/spaces endpoint.
repositoryId:
type: string
description: |
ID of an existing SCM repository to which the component should be placed.
Available repositories can be obtained through the /scm/provider/{providerType}/{providerId}/spaces/{spaceId}/repos endpoint.
nullable: true
LibraryCreateResponse:
required:
- displayName
- id
- state
- templateId
type: object
properties:
id:
type: string
description:
The unique identifier of the library. Based on the user-defined
library name.
displayName:
type: string
description:
The user-friendly name or label for the library. It allows
users to provide a clear and descriptive name that helps in identifying
and distinguishing different libraries easily. The field accepts free
text with alphanumeric and special characters.
description:
type: string
description: "
The detailed textual description of the library. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the library.
"
templateId:
type: string
description: "
An internal identifier of the scaffold selected for\
\ library creation. It includes information about the selected language,\
\ build tool and framework, if specified.
"
state:
description:
The current life-cycle status of the library.
allOf:
- $ref: "#/components/schemas/LibraryState"
LibraryLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to a library. Provide labelId to use\
\ an existing label, or text+color to create a new one."
LibraryLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from a library
LibraryRelease:
required:
- libraryId
- version
type: object
properties:
libraryId:
minLength: 1
type: string
description:
Unique identifier of the library.
version:
minLength: 1
type: string
description:
Version number.
LibraryState:
type: string
description: |
State of the library
CREATING - Library is being created
READY - Library is ready
FAILED - Library creation failed
DELETING - Library is being deleted
enum:
- CREATING
- READY
- FAILED
- DELETING
LibraryUpdateRequest:
type: object
properties:
description:
type: string
description: "
The detailed textual description of the library. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the library.
"
nullable: true
maxQueueSize:
maximum: 30
minimum: 2
type: integer
description: |-
The maximum number of builds that will be kept in the queue. Older builds will be archived.
This field is optional. If provided, it must be a value between 2 and 30.
format: int32
nullable: true
ciSettings:
description: "
The CI settings for the library. If provided, the CI\
\ settings will be updated.
"
nullable: true
allOf:
- $ref: "#/components/schemas/CiSettings"
description: Updated library specification
Link:
required:
- header
- type
- url
- version
type: object
properties:
type:
minLength: 1
type: string
description: "
The type of the payload: link
"
default: link
version:
minLength: 1
type: string
description: "
The version of the payload: v1
"
default: v1
url:
minLength: 1
type: string
description:
The URL of the link.
header:
minLength: 1
type: string
description:
The Header for display in result list.
description:
Link associated with the build.
ManagedComponentTemplatePropertyResponse:
required:
- componentVersion
- id
- properties
- version
type: object
properties:
id:
type: string
description:
The unique identifier of the managed service template.
version:
type: string
description:
The version of the managed service template.
componentVersion:
type: string
description:
The version of the managed service this template is based
on.
properties:
type: array
description:
User configurable template properties which can be used
to configure instances
items:
$ref: "#/components/schemas/ManagedComponentTemplatePropertyResponse.TemplateProperty"
ManagedComponentTemplatePropertyResponse.TemplateProperty:
required:
- defaultValue
- description
- name
- required
- type
type: object
properties:
name:
type: string
description:
Name of the property
description:
type: string
description:
Description of the property
defaultValue:
type: string
description:
Default value of the property
type:
type: string
description:
Type of the property
required:
type: boolean
description:
Whether the property is required
min:
type: integer
description:
Minimum value of the property
format: int32
max:
type: integer
description:
Maximum value of the property
format: int32
step:
type: integer
description:
Increment which can be used to increase the value of
the property
format: int32
options:
type: array
description:
List of available options for the property
items:
type: string
category:
type: string
description:
Category of the property
ManagedComponentTemplateResponse:
required:
- componentVersion
- id
- name
- version
type: object
properties:
id:
type: string
description:
The unique identifier of the managed service template.
version:
type: string
description:
The version of the managed service template.
name:
type: string
description:
The version of the managed service this template is based
on.
componentVersion:
type: string
description:
User configurable template properties which can be used
to configure instances
ManagedService:
required:
- accessControl
- displayName
- environmentId
- id
- status
- templateId
- templateVersion
- type
type: object
properties:
id:
type: string
description:
The unique identifier of the service. Based on the user-defined
service name.
displayName:
type: string
description:
The user-friendly name or label for the service. It allows
users to provide a clear and descriptive name that helps in identifying
and distinguishing different services easily. The field accepts free text
with alphanumeric and special characters.
description:
type: string
description: "
The detailed textual description of the service. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the service.
"
templateId:
type: string
description:
An internal identifier of the scaffold used for service
creation. It also provides information about the type or brand of the
service.
templateVersion:
type: string
description:
The version of the scaffold used for service creation.
environmentId:
type: string
description: "
The unique identifier of the environment where the service\
\ will be deployed. To obtain this identifier, use the GET /environments\
\ operation to retrieve a list of available environments.
This value\
\ is NOT set for a service of type \"ENTERPRISE\"."
status:
description:
The current life-cycle and readiness status of the service.
allOf:
- $ref: "#/components/schemas/ManagedServiceStatus"
createdAt:
type: string
description: "
The timestamp when the managed service was created.\
\ If the timestamp is unknown, the value will be returned as `null`."
format: date-time
createdBy:
type: string
description:
The username of the user who initialized the creation
of the managed service.
type:
type: string
description: "
The service type by management with two possible values:\
\ MANAGED for a service provided and managed by CodeNOW,\
\ or ENTERPRISE for a service managed by the customer outside\
\ of CodeNOW.
"
accessControl:
description:
An object specifying which environments are allowed to
access the service via the Connect Services feature of Application
Components.
allOf:
- $ref: "#/components/schemas/AccessControl"
adminConsoleUrl:
type: string
description:
The URL providing direct access to the service's specific
management interface.
nullable: true
errorCode:
type: string
description:
The error code returned if the service creation failed.
nullable: true
errorMessage:
type: string
description:
The error message returned if the service creation failed.
nullable: true
resourceLabels:
type: array
description: Labels attached to this managed service.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
ManagedServiceCreateRequest:
required:
- accessControl
- environmentId
- name
- template
type: object
properties:
name:
maxLength: 30
minLength: 3
type: string
description:
The user-friendly name or label for the service. It allows
users to provide a clear and descriptive name that helps in identifying
and distinguishing different services easily. The field accepts free text
with alphanumeric and special characters.
CodeNOW will generate an
ID for the service based on this name.
description:
type: string
description: "
The detailed textual description of the service. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the service.
"
nullable: true
template:
description: |
An object specifying the scaffold that should be used for service creation. It includes
information about the selected service type, scaffold version and configuration properties.
To obtain possible values, use the GET /templates/managed_services to retrieve
list of available templates.
And then use the GET /templates/managed_services/:templateId
to obtain list of available template properties.
allOf:
- $ref: "#/components/schemas/TemplateRequest"
environmentId:
minLength: 1
type: string
description: "
The unique identifier of the environment where the service\
\ will be deployed. To obtain this identifier, use the GET /environments\
\ operation to retrieve a list of available environments.
"
accessControl:
description:
An object specifying which environments are allowed to
access the service via the Connect Services feature of Application
Components.
allOf:
- $ref: "#/components/schemas/AccessControl"
description: Managed service specification
ManagedServiceCreateResponse:
required:
- createdBy
- displayName
- environmentId
- templateId
- templateVersion
- type
type: object
properties:
id:
type: string
displayName:
type: string
description:
The user-friendly name or label for the service. It allows
users to provide a clear and descriptive name that helps in identifying
and distinguishing different services easily. The field accepts free text
with alphanumeric and special characters.
description:
type: string
description: "
The detailed textual description of the service. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the service.
"
createdBy:
type: string
description:
The username of the user who initialized the creation
of the service.
templateId:
type: string
description:
An internal identifier of the scaffold used for service
creation. It also provides information about the type or brand of the
service.
templateVersion:
type: string
description:
The version of the scaffold used for service creation.
environmentId:
type: string
description: "
The unique identifier of the environment where the service\
\ will be deployed. To obtain this identifier, use the GET /environments\
\ operation to retrieve a list of available environments.
"
type:
type: string
description: "
The service type by management with two possible values:\
\ MANAGED for a service provided and managed by CodeNOW,\
\ or ENTERPRISE for a service managed by the customer outside\
\ of CodeNOW.
"
ManagedServiceLabelAttachRequest:
type: object
properties:
labelId:
type: string
description: "ID of an existing label to attach. If not provided, a new\
\ label will be created."
nullable: true
example: 550e8400-e29b-41d4-a716-446655440000
text:
maxLength: 100
minLength: 1
type: string
description: Text for a new label (required if labelId is not provided)
nullable: true
example: Production Ready
x-size-message: Label text must be between 1 and 100 characters
color:
pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
type: string
description: Color for a new label (required if labelId is not provided)
nullable: true
example: "#FF5733"
x-pattern-message: "Color must be a valid hex color (e.g., #FF0000 or #F00)"
description: "Request to attach a label to a managed service. Provide labelId\
\ to use an existing label, or text+color to create a new one."
ManagedServiceLabelDetachRequest:
required:
- labelId
type: object
properties:
labelId:
minLength: 1
type: string
description: ID of the label to detach
example: 550e8400-e29b-41d4-a716-446655440000
description: Request to detach a label from a managed service
ManagedServiceListItem:
required:
- displayName
- environmentId
- id
- status
- templateId
- templateVersion
- type
type: object
properties:
id:
type: string
description:
The unique identifier of the service. Based on the user-defined
service name.
displayName:
type: string
description:
The user-friendly name or label for the service. It allows
users to provide a clear and descriptive name that helps in identifying
and distinguishing different services easily. The field accepts free text
with alphanumeric and special characters.
description:
type: string
description: "
The detailed textual description of the service. Allows\
\ users to add additional context, notes, or any relevant information\
\ about the purpose, usage, or characteristics of the service.
"
templateId:
type: string
description:
An internal identifier of the scaffold used for service
creation. It also provides information about the type or brand of the
service.
templateVersion:
type: string
description:
The version of the scaffold used for service creation.
environmentId:
type: string
description: "
The unique identifier of the environment where the service\
\ will be deployed. To obtain this identifier, use the GET /environments\
\ operation to retrieve a list of available environments.
"
status:
description:
The current life-cycle and readiness status of the service.
allOf:
- $ref: "#/components/schemas/ManagedServiceStatus"
createdAt:
type: string
description: "
The timestamp when the managed service was created.\
\ If the timestamp is unknown, the value will be returned as `null`."
format: date-time
createdBy:
type: string
description:
The username of the user who initialized the creation
of the managed service.
type:
type: string
description: "
The service type by management with two possible values:\
\ MANAGED for a service provided and managed by CodeNOW,\
\ or ENTERPRISE for a service managed by the customer outside\
\ of CodeNOW.
"
errorCode:
type: string
description:
The error code returned if the service creation failed.
nullable: true
errorMessage:
type: string
description:
The error message returned if the service creation failed.
nullable: true
resourceLabels:
type: array
description: Labels attached to this managed service.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
ManagedServiceStatus:
type: string
description: |
Status of the managed service
READY - Service is ready
CREATING - Creating service
UPDATING - Updating service
DELETING - Deleting service
UNKNOWN - Status is unknown
DOWN - Service is down / not usable
FAILED_TO_CREATE - Service could not be created
FAILED_TO_UPDATE - Service could not be updated
enum:
- READY
- CREATING
- UPDATING
- DELETING
- UNKNOWN
- DOWN
- FAILED_TO_CREATE
- FAILED_TO_UPDATE
ManagedServiceUpdateRequest:
required:
- description
type: object
properties:
description:
type: string
description: |-
The detailed textual description of the service. Allows users to add additional context, notes,
or any relevant information about the purpose, usage, or characteristics of the service.
description: Updated managed service specification
Maven:
required:
- artifactId
- artifactVersion
- groupId
- repositoryUrl
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: "
The type of the payload: maven
"
default: maven
version:
minLength: 1
type: string
description: "
The version of the payload: v1
"
default: v1
repositoryUrl:
minLength: 1
type: string
description:
The URL of the maven repository.
groupId:
minLength: 1
type: string
description:
The group id of the maven artifact.
artifactId:
minLength: 1
type: string
description:
The artifact id of the maven artifact.
artifactVersion:
minLength: 1
type: string
description:
The version of the maven artifact.
description:
The maven artifact created by the build.
Npm:
required:
- artifactPath
- artifactVersion
- repositoryUrl
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: "
The type of the payload: npm
"
default: npm
version:
minLength: 1
type: string
description: "
The version of the payload: v1
"
default: v1
repositoryUrl:
minLength: 1
type: string
description:
The URL of the NPM repository.
artifactPath:
minLength: 1
type: string
description:
The path to the NPM artifact.
artifactVersion:
minLength: 1
type: string
description:
The version of the NPM artifact.
description:
The NPM package created by the build.
Nuget:
required:
- artifactVersion
- packageId
- repositoryUrl
- type
- version
type: object
properties:
type:
minLength: 1
type: string
description: "
The type of the payload: nuget
"
default: nuget
version:
minLength: 1
type: string
description: "
The version of the payload: v1
"
default: v1
repositoryUrl:
minLength: 1
type: string
description:
The URL of the Nuget repository.
packageId:
minLength: 1
type: string
description:
The package id of the Nuget artifact.
artifactVersion:
minLength: 1
type: string
description:
The version of the Nuget artifact.
description:
The Nuget package created by the build.
OkResponse:
required:
- status
type: object
properties:
status:
minLength: 1
type: string
Page_ApplicationComponentBuildResponse_:
type: object
allOf:
- $ref: "#/components/schemas/Slice_ApplicationComponentBuildResponse_"
- type: object
properties:
totalSize:
type: integer
format: int64
totalPages:
type: integer
format: int32
Page_ContainerBuildResponse_:
type: object
allOf:
- $ref: "#/components/schemas/Slice_ContainerBuildResponse_"
- type: object
properties:
totalSize:
type: integer
format: int64
totalPages:
type: integer
format: int32
Page_LibraryBuildResponse_:
type: object
allOf:
- $ref: "#/components/schemas/Slice_LibraryBuildResponse_"
- type: object
properties:
totalSize:
type: integer
format: int64
totalPages:
type: integer
format: int32
Pageable:
required:
- size
- sort
type: object
allOf:
- $ref: "#/components/schemas/Sort"
- type: object
properties:
number:
type: integer
format: int32
size:
type: integer
format: int32
mode:
$ref: "#/components/schemas/Pageable.Mode"
sort:
$ref: "#/components/schemas/Sort"
Pageable.Mode:
type: string
enum:
- CURSOR_NEXT
- CURSOR_PREVIOUS
- OFFSET
PayloadItem:
type: object
properties:
type:
type: string
version:
type: string
discriminator:
propertyName: type
mapping:
container: "#/components/schemas/Container"
maven: "#/components/schemas/Maven"
git-tag: "#/components/schemas/GitTag"
link: "#/components/schemas/Link"
npm: "#/components/schemas/Npm"
nuget: "#/components/schemas/Nuget"
git-revision: "#/components/schemas/GitRevision"
code-quality: "#/components/schemas/CodeQuality_1"
helm: "#/components/schemas/Helm"
oneOf:
- $ref: "#/components/schemas/GitRevision"
- $ref: "#/components/schemas/Container"
- $ref: "#/components/schemas/CodeQuality_1"
- $ref: "#/components/schemas/Helm"
- $ref: "#/components/schemas/GitTag"
- $ref: "#/components/schemas/Maven"
- $ref: "#/components/schemas/Nuget"
- $ref: "#/components/schemas/Npm"
- $ref: "#/components/schemas/Link"
PendingDeployment:
required:
- action
- id
- requestedAt
- requestedBy
- version
type: object
properties:
id:
type: string
description: Identifier of the queue entry.
example: b12a3f40-7a28-4cd3-b51f-4ab6e77d1cbd
version:
type: string
description: Application package version awaiting deployment.
example: 1.5.0-rc.1
requestedAt:
type: string
description: Timestamp the deployment was requested.
format: date-time
example: 2026-04-21T08:15:00Z
requestedBy:
type: string
description: Identifier of the user who requested the deployment.
example: alice@acme.com
approvalId:
type: string
description: "Identifier of the approval record blocking this deployment,\
\ if any."
example: a9d5e2b0-9a3c-4a6b-9e01-9c6f0e2f1d88
action:
description: Action being performed (DEPLOY or UNDEPLOY).
allOf:
- $ref: "#/components/schemas/DeploymentAction"
packageLabels:
type: array
description: Labels attached to the underlying application package. Only
present when the `packageLabels` expand is requested.
nullable: true
items:
$ref: "#/components/schemas/LabelBriefResponse"
approvers:
type: array
description: Identities (users or teams) that can approve this pending deployment.
nullable: true
items:
$ref: "#/components/schemas/IdentityRef"
description: Deployment queued and waiting (typically on a quality-gate approval)
before it becomes an active `Deployment`. Only present when the `pendingDeployments`
expand is requested. `pendingDeployment` and `jobRun` are eventually consistent;
treat the pair as a snapshot.
PipelinesResponse:
required:
- customPipelines
- defaultPipelines
type: object
properties:
customPipelines:
type: array
description: List of custom CI pipelines.
items:
type: string
defaultPipelines:
description:
The section contains default CodeNOW CI pipelines.
allOf:
- $ref: "#/components/schemas/DefaultPipelines"
RelatedDeploymentTargetsResponse:
required:
- environments
- labels
type: object
properties:
environments:
description: Direct environment access policy and the environments it authorizes.
allOf:
- $ref: "#/components/schemas/RelatedDeploymentTargetsResponse.Environments"
labels:
description: Label access policy and the labels it authorizes.
allOf:
- $ref: "#/components/schemas/RelatedDeploymentTargetsResponse.Labels"
description: "Effective deployment targets for an application — the access policies\
\ that determine which environments and labels the application may be deployed\
\ to, together with the resolved items those policies match. Each block (`environments`,\
\ `labels`) carries a `mode` (`ANY`, `DENY_ALL`, `WHITELIST`) and the resolved\
\ `items` authorized by that policy."
RelatedDeploymentTargetsResponse.EnvironmentItem:
required:
- allowsTriggeredDeployments
- customerClusterId
- displayName
- id
type: object
properties:
id:
type: string
description: Identifier of the environment. May be absent for placeholder
entries (e.g. a label-resolved item whose underlying environment no longer
exists).
nullable: true
example: env-prod-eu
displayName:
type: string
description: Human-readable name of the environment.
example: Production EU
status:
description: "Current runtime status of the environment, when resolvable\
\ against its cluster. Expandable with `status`"
nullable: true
allOf:
- $ref: "#/components/schemas/EnvironmentStatus"
hasQualityGate:
type: boolean
description: Whether a quality gate is configured for this environment.
nullable: true
example: true
customerClusterId:
type: string
description: Identifier of the cluster hosting this environment.
example: cluster-eu-1
allowsTriggeredDeployments:
type: boolean
description: Whether deployments to this environment may be triggered automatically
(e.g. by CI).
description: Environment authorized for application deployment.
RelatedDeploymentTargetsResponse.Environments:
required:
- items
- mode
type: object
properties:
mode:
description: "Policy mode. `ANY` allows all environments, `DENY_ALL` allows\
\ none, `WHITELIST` allows only those listed in `items`."
allOf:
- $ref: "#/components/schemas/RelatedTargetMode"
items:
type: array
description: Environments authorized by the policy. Empty when `mode = DENY_ALL`;
for `mode = WHITELIST` lists exactly the whitelisted environments; for
`mode = ANY` lists all environments available to the account.
items:
$ref: "#/components/schemas/RelatedDeploymentTargetsResponse.EnvironmentItem"
description: "Direct environment access policy: a policy `mode` and the resolved\
\ environments authorized by it."
RelatedDeploymentTargetsResponse.LabelItem:
required:
- color
- id
- text
type: object
properties:
id:
type: string
description: Identifier of the label.
example: 5d4f9b92-1f8e-4e57-8d1a-8b3e1a4d8e72
text:
type: string
description: Display text of the label.
example: Production EU
color:
type: string
description: Color code used to render the label badge (hex RGB).
example: "#FF8800"
description:
type: string
description: Optional human-readable description of the label.
nullable: true
example: Production environments in the EU region
description: Label authorized by the label policy.
RelatedDeploymentTargetsResponse.Labels:
required:
- items
- mode
type: object
properties:
mode:
description: "Policy mode. `ANY` allows all labels, `DENY_ALL` allows none,\
\ `WHITELIST` allows only those listed in `items`."
allOf:
- $ref: "#/components/schemas/RelatedTargetMode"
items:
type: array
description: Labels authorized by the policy. Empty when `mode = DENY_ALL`;
for `mode = WHITELIST` lists exactly the whitelisted labels; for `mode
= ANY` lists all labels available to the account.
items:
$ref: "#/components/schemas/RelatedDeploymentTargetsResponse.LabelItem"
description: "Label access policy: a policy `mode` and the resolved labels authorized\
\ by it."
RelatedTargetMode:
type: string
description: "Policy mode controlling which related deployment targets of a\
\ given kind are usable. ANY = no constraint, all targets allowed. DENY_ALL\
\ = no targets of this kind may be used. WHITELIST = only the explicitly listed\
\ ids may be used."
enum:
- ANY
- DENY_ALL
- WHITELIST
RelatedTargetsConfig:
required:
- mode
type: object
properties:
mode:
$ref: "#/components/schemas/RelatedTargetsConfig.Mode"
ids:
type: array
nullable: true
items:
type: string
RelatedTargetsConfig.Mode:
type: string
enum:
- ANY
- DENY_ALL
- WHITELIST
RepositoryTreeItem:
required:
- name
- occupied
- treeId
- type
type: object
properties:
name:
type: string
description:
Name of the tree item.
type:
type: string
description: |
Type of the tree item:
tree - folder
blob - file
treeId:
type: string
description:
ID of the tree that represents folder in the repository.
occupied:
type: string
description: |
Defines if the tree item is occupied or it would hosted new application component:
PARENT_FOLDER - These folders are considered as occupied because
creation of the new component would cause merging one component
to structure of another one.
APP_COMPONENT - These folders are occupied by others application components.
FREE - These folders would hosted new application component.
ResourceReference:
required:
- resourceId
- resourceType
type: object
properties:
resourceType:
description: Type of the resource
example: CONTAINER
allOf:
- $ref: "#/components/schemas/LabelResourceType"
resourceId:
minLength: 1
type: string
description: ID of the resource
example: my-container-app
displayName:
type: string
description: Display name of the resource
nullable: true
example: My Container Application
version:
type: string
description: Version of the resource
nullable: true
example: 1.2.3
parentResourceType:
type: string
description: Type of the parent resource
nullable: true
parentResourceId:
type: string
description: ID of the parent resource
nullable: true
description: Reference to a resource that can be labeled
ResourceReferenceRequest:
required:
- resourceId
- resourceType
type: object
properties:
resourceType:
description: Type of the resource
example: CONTAINER
allOf:
- $ref: "#/components/schemas/LabelResourceType"
resourceId:
minLength: 1
type: string
description: ID of the resource
example: my-container-app
description: Reference to a resource for attach/detach operations
RuntimeConfig:
required:
- replicas
- resources
type: object
properties:
replicas:
maximum: 40
minimum: 1
type: integer
description: "
The number of instances (containers) of this application\
\ component run in parallel. Minimum value is 1, maximum value is 40."
format: int32
resources:
description: |
An object specifying the minimum required and maximum allowed resources (CPU and memory)
needed by the containers running this application component.
allOf:
- $ref: "#/components/schemas/RuntimeConfig.Resources"
RuntimeConfig.Limits:
type: object
properties:
cpu:
minLength: 1
type: string
description: |-
The maximum allowed CPU allocation for the containers running this application component.
It accepts two possible units: cpu (cpu core), represented by a simple number (decimals allowed),
and m (thousandth of a core), denoted by the 'm' suffix. For example, '1000m' is equivalent to '1'.
The value must not be less than 1m (0.001).
nullable: true
memory:
minLength: 1
type: string
description: |-
The maximum allowed memory allocation for the container running this application component in bytes.
You can express the value as a plain integer, a number in exponential format or as a fixed-point number using one
of these quantity suffixes: E, P, T, G, M,
k. You can also use the power-of-two equivalents: Ei, Pi, Ti,
Gi, Mi, Ki. For example, the following represent roughly the same value:
128974848, 129e6, 129M, 128974848000m, 123Mi.
The value must not be less than 1k (1000 bytes).
nullable: true
RuntimeConfig.Requests:
type: object
properties:
cpu:
minLength: 1
type: string
description: |
The required CPU allocation for the containers running this application component.
It accepts two possible units: cpu (cpu core), represented by a simple number (decimals allowed),
and m (thousandth of a core), denoted by the 'm' suffix. For example, '1000m' is equivalent to '1'.
The value must not be less than 1m (0.001).
The value must be less than or equal to the CPU limit value.
nullable: true
memory:
minLength: 1
type: string
description: |
The required memory allocation for the containers running this application component in bytes.
You can express the value as a plain integer, a number in exponential format or as a fixed-point number using one
of these quantity suffixes: E, P, T, G, M,
k. You can also use the power-of-two equivalents: Ei, Pi, Ti,
Gi, Mi, Ki. For example, the following represent roughly the same value:
128974848, 129e6, 129M, 128974848000m, 123Mi.
The value must not be less than 1k (1000 bytes).
The value must be less than or equal to the memory limit value.
nullable: true
RuntimeConfig.Resources:
type: object
properties:
limits:
description: |-
The maximum allowed resource allocation (CPU and memory) to the containers running this application component.
If some of the values are omitted, it means they are not set.
allOf:
- $ref: "#/components/schemas/RuntimeConfig.Limits"
requests:
description: |-
The required resources (CPU and memory) needed by the containers running this application component.
If some of the values are omitted, it means they are not set.
allOf:
- $ref: "#/components/schemas/RuntimeConfig.Requests"
ScmProviderResponse:
required:
- actions
- description
- enabled
- instanceId
- name
- state
- type
- url
type: object
properties:
instanceId:
type: string
type:
type: string
name:
type: string
description:
type: string
url:
type: string
actions:
type: array
items:
$ref: "#/components/schemas/ActionType"
state:
$ref: "#/components/schemas/ThirdParty.State"
enabled:
type: boolean
ScmRepository:
required:
- httpUrl
- id
- name
- occupied
- spaceId
type: object
properties:
id:
type: string
description:
ID of the repository
spaceId:
type: string
description:
ID of the space where the repository is hosted.
name:
type: string
description:
Name of the repository.
occupied:
type: boolean
description:
Defines if the repository is occupied or it would hosted
new application component.
httpUrl:
type: string
description:
HTTP URL of the repository.
ScmSpec:
required:
- httpAddress
- sshAddress
type: object
properties:
provider:
type: string
description: |
The name of the SCM provider associated with the application component, facilitating version control and collaborative software development.
nullable: true
providerType:
type: string
description: "
CI Provider type (github, codenow, etc)
"
nullable: true
id:
type: string
description:
The unique identifier of the application component repository
or project within the SCM system.
nullable: true
sshAddress:
type: string
description:
The SSH address string required for performing a Git
clone operation on the repository linked to the application component.
httpAddress:
type: string
description:
The HTTP address string required for performing a Git
clone operation on the repository linked to the application component.
ScmSpec_1:
required:
- httpAddress
- sshAddress
type: object
properties:
provider:
type: string
description: |
The name of the SCM provider associated with the container, facilitating version control and collaborative software development.
nullable: true
providerType:
type: string
description: "
CI Provider type (github, codenow, etc)
"
nullable: true
id:
type: string
description:
The unique identifier of the container repository or
project within the SCM system.
nullable: true
sshAddress:
type: string
description:
The SSH address string required for performing a Git
clone operation on the repository linked to the container.
httpAddress:
type: string
description:
The HTTP address string required for performing a Git
clone operation on the repository linked to the container.
ScmSpec_2:
required:
- httpAddress
- sshAddress
type: object
properties:
provider:
type: string
description: |
The name of the SCM provider associated with the library, facilitating version control and collaborative software development.
nullable: true
providerType:
type: string
description: "
CI Provider type (github, codenow, etc)
"
nullable: true
id:
type: string
description:
The unique identifier of the library repository or project
within the SCM system.
nullable: true
sshAddress:
type: string
description:
The SSH address string required for performing a Git
clone operation on the repository linked to the library.
httpAddress:
type: string
description:
The HTTP address string required for performing a Git
clone operation on the repository linked to the library.
ServiceTemplateType:
type: string
enum:
- MANAGED_COMPONENT
- EXTERNAL
Settings:
required:
- contextPath
- maxQueueSize
type: object
properties:
contextPath:
type: string
description: Context path used for constructing the preview URL of the application
component
maxQueueSize:
type: integer
description: Maximum number of builds with accessible logs before they are
archived
format: int32
Settings_1:
required:
- maxQueueSize
type: object
properties:
maxQueueSize:
type: integer
description: Maximum number of builds with accessible logs before they are
archived
format: int32
Settings_2:
required:
- maxQueueSize
type: object
properties:
maxQueueSize:
type: integer
description: Maximum number of builds with accessible logs before they are
archived
format: int32
Slice_ApplicationComponentBuildResponse_:
required:
- content
- pageable
type: object
properties:
content:
type: array
items:
$ref: "#/components/schemas/ApplicationComponentBuildResponse"
pageable:
$ref: "#/components/schemas/Pageable"
pageNumber:
type: integer
format: int32
offset:
type: integer
format: int64
size:
type: integer
format: int32
empty:
type: boolean
numberOfElements:
type: integer
format: int32
Slice_ContainerBuildResponse_:
required:
- content
- pageable
type: object
properties:
content:
type: array
items:
$ref: "#/components/schemas/ContainerBuildResponse"
pageable:
$ref: "#/components/schemas/Pageable"
pageNumber:
type: integer
format: int32
offset:
type: integer
format: int64
size:
type: integer
format: int32
empty:
type: boolean
numberOfElements:
type: integer
format: int32
Slice_LibraryBuildResponse_:
required:
- content
- pageable
type: object
properties:
content:
type: array
items:
$ref: "#/components/schemas/LibraryBuildResponse"
pageable:
$ref: "#/components/schemas/Pageable"
pageNumber:
type: integer
format: int32
offset:
type: integer
format: int64
size:
type: integer
format: int32
empty:
type: boolean
numberOfElements:
type: integer
format: int32
Sort:
required:
- orderBy
type: object
properties:
orderBy:
type: array
items:
$ref: "#/components/schemas/Sort.Order"
Sort.Order:
required:
- direction
- ignoreCase
- property
type: object
properties:
ignoreCase:
type: boolean
direction:
$ref: "#/components/schemas/Sort.Order.Direction"
property:
type: string
ascending:
type: boolean
Sort.Order.Direction:
type: string
enum:
- ASC
- DESC
TaskGroupStatus:
type: string
description: Status of the task group owning the deployment job run.
enum:
- PENDING
- IN_PROGRESS
- WAITING
- FAILED
- COMPLETED
- CANCELLED
TeamCreateRequest:
required:
- name
type: object
properties:
name:
minLength: 1
pattern: "^(?![0-9]|_|-)[a-zA-z0-9_-]{1,30}"
type: string
description:
The user-friendly name of the team.
description:
type: string
description:
The detailed textual description of the team.
nullable: true
TeamListItemResponse:
required:
- createdAt
- createdBy
- id
- name
type: object
properties:
id:
minLength: 1
type: string
description:
The unique identifier of the team.
format: uuid
name:
minLength: 1
type: string
description:
The user-friendly name of the team.
description:
type: string
description: |-
The detailed textual description of the team. Allows users to add additional context,
notes, or any relevant information about the purpose, usage, or characteristics of the team.
nullable: true
createdAt:
type: string
description: |-
The timestamp denoting when the team was created. It is an automatically generated value that
records the exact date and time when the team was added to the system.
format: date-time
createdBy:
type: string
description:
The username of the user who created the team.
TeamMemberAddRequest:
required:
- username
type: object
properties:
username:
minLength: 1
type: string
description: |-
The unique identifier of the user we are adding as a team member consists
of a username string.
TeamResponse:
required:
- createdAt
- createdBy
- id
- members
- name
type: object
properties:
id:
minLength: 1
type: string
description:
The unique identifier of the team.
format: uuid
name:
minLength: 1
type: string
description:
The user-friendly name of the team.
description:
type: string
description: |-
The detailed textual description of the team. Allows users to add additional context,
notes, or any relevant information about the purpose, usage, or characteristics of the team.
nullable: true
createdAt:
type: string
description: |-
The timestamp denoting when the team was created. It is an automatically generated value that
records the exact date and time when the team was added to the system.
format: date-time
createdBy:
type: string
description:
The username of the user who created the team.
members:
type: array
description: |-
List of members who belong to the team, with each user represented by a username string.
items:
type: string
Template:
required:
- buildSystem
- buildSystemVersion
- custom
- description
- framework
- frameworkVersion
- id
- language
- languageVersion
- name
- properties
- version
type: object
properties:
id:
type: string
description:
The unique identifier of the library template.
version:
type: string
description: "
The currently provided version of the library template,\
\ using semantic versioning.
"
name:
type: string
description:
The user-friendly name or label for the library template.
language:
type: string
description:
The programming language supported by a library created
from the template.
languageVersion:
type: string
description:
The version of the programming language supported by
a library created from the template.
description:
type: string
description: "
The textual description of the library template, which\
\ may provide some additional information in a user-friendly form."
buildSystem:
type: string
description:
The name of the build system utilized by a library created
from the template.
buildSystemVersion:
type: string
description:
The version of the build system utilized by a library
created from the template.
framework:
type: string
description:
The name of the framework integrated with a library created
from the template.
frameworkVersion:
type: string
description:
The version of the framework integrated with a library
created from the template.
custom:
type: boolean
description: "
A boolean flag indicating whether the template is user-customized.\
\ If set to false, the template is provided by CodeNOW.
"
properties:
type: array
description:
A list of objects representing customizable template
properties.
items:
$ref: "#/components/schemas/TemplateProperty"
TemplateProperty:
required:
- description
- name
- required
- type
type: object
properties:
name:
type: string
description: "
The name of the property, also serving as the unique\
\ identifier or key.
"
description:
type: string
description: "
The textual description of the property, providing better\
\ understanding of the property's function or context in a user-friendly\
\ form.
"
type:
type: string
description:
The required data type of the property's value.
required:
type: boolean
description: "
A boolean flag indicating whether the property is mandatory.\
\ If set to false, the property may be omitted.
"
TemplateRequest:
required:
- id
- version
type: object
properties:
id:
minLength: 1
type: string
description: "
An internal identifier of the scaffold selected for\
\ library creation.It includes information about the selected language,\
\ build tool and framework, if specified.
"
version:
minLength: 1
type: string
description:
The desired version of the selected template. It is only
required if multiple versions of the template are available.
properties:
type: object
additionalProperties:
type: string
description: |
A map of properties ("key": "value") required for proper template configuration.
TemplateSpec:
required:
- id
- version
type: object
properties:
id:
minLength: 1
type: string
description: |
An internal identifier of the scaffold selected for library creation.
It includes information about the selected language, build tool and framework, if specified.
Available templates can be obtained through the:
/templates/application_components endpoint for application component or
/templates/libraries endpoint for library
version:
minLength: 1
type: string
description: |
The desired version of the selected template.
Available templates can be obtained through the:
/templates/application_components endpoint for application component or
/templates/libraries endpoint for library
properties:
type: object
additionalProperties:
type: string
description: |
A map of properties ("key": "value") required for proper template configuration.
Available templates can be obtained through the:
/templates/application_components endpoint for application component or
/templates/libraries endpoint for library
TemplateSpecV2:
required:
- custom
- id
- version
type: object
properties:
id:
minLength: 1
type: string
description: |
An internal identifier of the scaffold selected for application component creation.
It includes information about the selected language, build tool and framework, if specified.
Available templates can be obtained through the:
/templates/application_components endpoint for application component or
/templates/libraries endpoint for library
version:
minLength: 1
type: string
description: |
The desired version of the selected template.
Available templates can be obtained through the:
/templates/application_components endpoint for application component or
/templates/libraries endpoint for library
custom:
type: boolean
description: |
A boolean flag indicating whether the template is user-customized. If set to false, the template is provided by CodeNOW.
Available templates can be obtained through the:
/templates/application_components endpoint for application component or
/templates/libraries endpoint for library
properties:
type: object
additionalProperties:
type: string
description: |
A map of properties ("key": "value") required for proper template configuration.
Available templates can be obtained through the:
/templates/application_components endpoint for application component or
/templates/libraries endpoint for library
ThirdParty.State:
type: string
enum:
- ACTIVE
- SETUP
Trigger:
required:
- branch
- pipeline
type: object
properties:
event:
type: string
description:
The event that will activate this trigger on every occurrence.
The default value is push
pipeline:
minLength: 1
type: string
description: |
The pipeline used for building the component.
It generally depends on the template (language, build tool, framework) the component is based on.
enabled:
type: boolean
description: |-
A boolean flag indicating whether the trigger is active.
If missing or set to false, the trigger will stay defined in the configuration file, but will not execute.
branch:
minLength: 1
type: string
description: |-
The git branch(es) associated with the trigger. event occurrences on this branch will execute the trigger.
You can specify either a single branch name or a glob pattern potentially matching multiple branches.
applicationPackage:
description: |-
An object specifying the version to be used for creating a new application package after the component release, if any.
If no value is provided, no new package will be created upon the release of the component during trigger execution.
allOf:
- $ref: "#/components/schemas/Trigger.ApplicationPackage"
deployments:
type: array
description: |-
A list of objects specifying the deployment of the application package potentially created in the previous step
to specific environment(s) and the corresponding configurations to be used.
An empty or missing list indicates that no deployments will be executed.
items:
$ref: "#/components/schemas/Trigger.Deployment"
type:
type: string
description: |-
The primary action executed by the trigger.
Default value is preview, representing a preview build,
the other possible value is release, representing a release build.
version:
description: |-
Specifies how to determine the next version of the component.
You must choose either version pattern or a branch pattern.
If no version is specified, the patch version of the last major and minor path will be incremented.
nullable: true
allOf:
- $ref: "#/components/schemas/Trigger.Version"
Trigger.ApplicationPackage:
type: object
properties:
versionPattern:
type: string
description: |-
The semver pattern used for versioning the application package created after the component release.
Use pattern with wildcards to specify package version
(? latest, + increment, i.e. 1.?.+ will increment patch version for the latest version where major path is 1).
Trigger.Deployment:
required:
- configuration
- environment
type: object
properties:
enabled:
type: boolean
description: |-
A boolean flag indicating whether the deployment should be executed.
If missing or set to false, the deployment will stay defined in the configuration file, but will not execute.
environment:
minLength: 1
type: string
description:
The ID of the environment the application should be deployed
to.
configuration:
minLength: 1
type: string
description: |-
Specification of the deployment configuration used for the deployment.
The two valid values are latest, representing the highest versioned defined configuration,
and branch, representing the configuration stored in the branch associated with the trigger.
Trigger.Version:
type: object
properties:
pattern:
type: string
description: |-
The semver pattern used for versioning the component builds.
Use pattern with wildcards to specify release version
(? latest, + increment, i.e. 1.?.+ will increment patch version for the latest version where major path is 1).
branchPattern:
minLength: 1
type: string
description: |-
The release version will be determined from the branch name following this pattern.
${MAJOR}, ${MINOR} can be used as placeholders. i.e release/${MAJOR}.${MINOR} for release/1.5
will creates 1.5.0, 1.5.1, etc builds versions.
Trigger.Version_1:
type: object
properties:
pattern:
type: string
description: |-
The semver pattern used for versioning the container builds.
Use pattern with wildcards to specify release version
(? latest, + increment, i.e. 1.?.+ will increment patch version for the latest version where major path is 1).
nullable: true
branchPattern:
minLength: 1
type: string
description: |-
The release version will be determined from the branch name following this pattern.
${MAJOR}, ${MINOR} can be used as placeholders. i.e release/${MAJOR}.${MINOR} for release/1.5
will creates 1.5.0, 1.5.1, etc builds versions.
nullable: true
Trigger.Version_2:
type: object
properties:
pattern:
type: string
description: |-
The semver pattern used for versioning the library builds.
Use pattern with wildcards to specify release version
(? latest, + increment, i.e. 1.?.+ will increment patch version for the latest version where major path is 1).
branchPattern:
minLength: 1
type: string
description: |-
The release version will be determined from the branch name following this pattern.
${MAJOR}, ${MINOR} can be used as placeholders. i.e release/${MAJOR}.${MINOR} for release/1.5
will creates 1.5.0, 1.5.1, etc builds versions.
Trigger_1:
required:
- branch
- pipeline
type: object
properties:
event:
type: string
description:
The event that will activate this trigger on every occurrence.
The default value is push
nullable: true
pipeline:
minLength: 1
type: string
description: |
The pipeline used for building the container.
It generally depends on the template (language, build tool, framework) the container is based on.
enabled:
type: boolean
description: |-
A boolean flag indicating whether the trigger is active.
If missing or set to false, the trigger will stay defined in the configuration file, but will not execute.
nullable: true
branch:
minLength: 1
type: string
description: |-
The git branch(es) associated with the trigger. event occurrences on this branch will execute the trigger.
You can specify either a single branch name or a glob pattern potentially matching multiple branches.
type:
type: string
description: |-
The primary action executed by the trigger.
For containers, only release is a valid value, representing the release build.
nullable: true
version:
description: |-
Specifies how to determine the next version of the container.
You can provide either your own version pattern or a branch pattern.
If no value is provided, the patch version for the last major and minor path will be incremented.
nullable: true
allOf:
- $ref: "#/components/schemas/Trigger.Version_1"
Trigger_2:
required:
- branch
- pipeline
type: object
properties:
event:
type: string
description:
The event that will activate this trigger on every occurrence.
The default value is push
pipeline:
minLength: 1
type: string
description: |
The pipeline used for building the library.
It generally depends on the template (language, build tool, framework) the library is based on.
enabled:
type: boolean
description: |-
A boolean flag indicating whether the trigger is active.
If missing or set to false, the trigger will stay defined in the configuration file, but will not execute.
branch:
minLength: 1
type: string
description: |-
The git branch(es) associated with the trigger. event occurrences on this branch will execute the trigger.
You can specify either a single branch name or a glob pattern potentially matching multiple branches.
type:
type: string
description: |-
The primary action executed by the trigger.
For libraries, only release is a valid value, representing the release build.
version:
description: |-
Specifies how to determine the next version of the library.
You can provide either your own version pattern or a branch pattern.
If no value is provided, the patch version for the last major and minor path will be incremented.
nullable: true
allOf:
- $ref: "#/components/schemas/Trigger.Version_2"
User:
required:
- email
- name
- role
- username
type: object
properties:
username:
minLength: 1
type: string
description:
Unique identifier of the user (username).
name:
minLength: 1
type: string
description:
Full name of the user.
email:
minLength: 1
type: string
description:
User's email.
role:
description: "
CodeNow role assigned to user. Valid roles are: CODENOW,\
\ OWNER, ADMIN, USER .
"
allOf:
- $ref: "#/components/schemas/UserRole"
UserController.UserDetail:
type: object
properties:
username:
type: string
description: Username of the logged in user
accountId:
type: string
description: Account of the logged in user
description: User detail
UserRole:
type: string
enum:
- CODENOW
- OWNER
- ADMIN
- USER
UserSshKey:
required:
- id
type: object
properties:
id:
type: integer
description:
The unique identifier of the user SSH key.
format: int32
title:
type: string
description:
User defined title for the SSH key.
key:
type: string
description:
The public part of user's SSH key.
createdAt:
type: string
description:
Timestamp indicating when the key was uploaded to CodeNow.
format: date-time
description: User public SSH key object
UserSshKeyUploadRequest:
required:
- key
- title
type: object
properties:
title:
maxLength: 30
minLength: 3
type: string
description:
The user-defined title for public SSH key.
key:
type: string
description:
Public SSH key.
description: User public SSH key specification
WorkerNode:
required:
- cloudProvider
- workerNodeCount
- workerNodeType
type: object
properties:
cloudProvider:
type: string
description:
Name of the cloud provider used to provision the worker
nodes in the cluster. This value remains the same across all worker nodes
in the cluster.
workerNodeType:
type: string
description:
Type or instance size of the worker nodes.
workerNodeCount:
type: integer
description:
Number of worker nodes of given type in the cluster.
format: int32