API docs by Redocly

Devtron APIs Specs (1.0.0)

Download OpenAPI specification:

License: Apache 2.0

Application Metadata

Application metadata and information retrieval

List all app labels

This API will return all the labels available in the database.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Get application meta info

Application basic info, projects and labels

path Parameters
appId
required
integer <int64>

application id

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Get Helm application meta info

Application info for all types of Helm apps

path Parameters
appId
required
string

application id

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Job Management

Job management operations for creating, cloning, and retrieving jobs

Create or clone a job

Create and clone a job

Request Body schema: application/json
required
appName
string

Used to give the name of the job

isJob
boolean

States whether its a job or an app

teamId
integer

Used to give project id

templateId
integer

Used to give the id of the job it wants to clone

Array of objects
description
string

Used to give the description of the job once it is made.

Responses

Request samples

Content type
application/json
{
  • "appName": "my-job-1",
  • "isJob": true,
  • "teamId": 1,
  • "templateId": 18,
  • "labels": [
    ],
  • "description": "This is my first Job"
}

Response samples

Content type
application/json
{
  • "id": 25,
  • "appName": "my-job-1",
  • "material": [
    ],
  • "teamId": 1,
  • "templateId": 0,
  • "description": "This is my first Job",
  • "isJob": true
}

List jobs

Get the list of all the jobs by applying filter

Request Body schema: application/json
required
teams
Array of integers

used to give the project id

appStatuses
Array of strings

used to give the filter of app ci-build status

sortBy
string

used to give the sort by constraint

sortOrder
string

used to give the sort order

offset
integer

used to give the number from which we want our job (if the offset is 20 means we want list of jobs from 20)

size
integer

used to give the number of jobs we want

Responses

Request samples

Content type
application/json
{
  • "teams": [
    ],
  • "appStatuses": [
    ],
  • "sortBy": "appNameSort",
  • "sortOrder": "ASC",
  • "offset": 0,
  • "size": 20
}

Response samples

Content type
application/json
{
  • "jobContainers": [
    ],
  • "jobCount": 0
}

Get job CI pipeline list

fetch details of job ci-pipelines for the overview page

path Parameters
jobId
required
integer

Job Id

header Parameters
token
required
string

Authentication token.

Responses

Helm Chart Management

Helm chart deployment management and operations

List deployed charts

deployed chart listing, with search filters

query Parameters
envs
Array of strings

environment ids

chartRepoId
Array of strings

chart repo ids

appStoreName
string

chart name

appName
string

chart name as app name for devtron

onlyDeprecated
boolean

show only deprecated or all

offset
integer

offset for result set

size
integer

total request size.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": [
    ]
}

Fetch notes.txt for deployed helm charts

Used to fetch notes.txt for helm charts deployed via gitOps

query Parameters
env-id
required
integer

it is an environment id of app

installed-app-id
required
integer

it is a installed application id

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "notes": "string"
}

List Applications

Application listing

List application autocomplete

list of namespaces group by clusters

query Parameters
appName
string
Example: appName=abc

app name, wildcard query

teamId
integer
Example: teamId=1

project id

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": [ ]
}

Application Management

Application management operations including creation, listing, and updates

Create a new application

create new application

Request Body schema: application/json
required

json as request body

appName
required
string

app name

teamId
required
integer

project id

templateId
required
integer

reference app id, used for clone, set default value 0 for blank app.

Array of objects (AppLabel)

each apps may have multiple labels. these are optional.

Responses

Request samples

Content type
application/json
{
  • "appName": "string",
  • "teamId": 0,
  • "templateId": 0,
  • "labels": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Update application projects and labels

update application projects and labels

Request Body schema: application/json
required

json as request body

appName
required
string

app name

teamId
required
integer

project id

templateId
required
integer

reference app id, used for clone, set default value 0 for blank app.

Array of objects (AppLabel)

each apps may have multiple labels. these are optional.

Responses

Request samples

Content type
application/json
{
  • "appName": "string",
  • "teamId": 0,
  • "templateId": 0,
  • "labels": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

List applications

app listing, collection of deployed applications or undeployed or incomplete configured apps.

Request Body schema: application/json
required

json as request body

appNameSearch
string

app name search, wildcard match

offset
required
integer

offset

size
required
integer

result size

sortBy
string

sort by

sortOrder
string

sort order

environments
Array of integers

environment id

teams
Array of integers

team id, teams ids are projects ids

labels
Array of strings

app labels

statuses
Array of strings

status

Responses

Request samples

Content type
application/json
{
  • "appNameSearch": "string",
  • "offset": 0,
  • "size": 0,
  • "sortBy": "string",
  • "sortOrder": "string",
  • "environments": [
    ],
  • "teams": [
    ],
  • "labels": [
    ],
  • "statuses": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Update project for app

update project for app

Request Body schema: application/json
required

json as request body

teamId
required
integer

project id

appId
required
Array of integers

team id, teams ids are projects ids

Responses

Request samples

Content type
application/json
{
  • "teamId": 0,
  • "appId": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Labels

List Application Labels

Retrieves a list of application labels. By default, returns all labels. Use the showPropagatedOnly parameter to filter for labels where propagate = true.

Required Token Permission:

  • Must have View access to the applications in scope.
query Parameters
showPropagatedOnly
boolean
Default: false

If true, only returns labels where propagate = true. If false or not provided, all labels are returned.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
Example

Example response when showPropagatedOnly is false or not provided

{
  • "code": 200,
  • "status": "OK",
  • "result": [
    ]
}

BulkGetData

Get Readme for Bulk Update

Returns Readme for bulk update for different resource in the url

path Parameters
apiVersion
required
string

apiVersion of the resource

kind
required
string

kind of the resource

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "resource": "string",
  • "script": {
    },
  • "readMe": "string"
}

Dry Run for Bulk Application Update

Returns details(id, name, envId) of all apps to be impacted with bulk update

Request Body schema: application/json
required

A JSON object containing information by which apps will be filtered

apiVersion
string

Api version from url

kind
string

Kind

object (BulkUpdatePayload)

Responses

Request samples

Content type
application/json
{
  • "apiVersion": [
    ],
  • "kind": [
    ],
  • "spec": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

BulkUpdate

Bulk Hibernate Applications

Bulk Hibernates applications

Request Body schema: application/json
required

A JSON object containing information about applications and environments to hibernate.

object (NameIncludesExcludes)
object (NameIncludesExcludes)
envIds
Array of integers

All Env Id's for the bulk action

appIds
Array of integers

All App Id's for the bulk action (alternative to includes/excludes by name)

projectIds
Array of integers

All Project Id's for the bulk action

Responses

Request samples

Content type
application/json
{
  • "includes": {
    },
  • "excludes": {
    },
  • "envIds": [
    ],
  • "appIds": [
    ],
  • "projectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": [
    ],
  • "failure": [
    ],
  • "successful": [
    ]
}

Bulk Un-Hibernate Applications

Bulk Un-Hibernates applications

Request Body schema: application/json
required

A JSON object containing information about applications and environments to un-hibernate.

object (NameIncludesExcludes)
object (NameIncludesExcludes)
envIds
Array of integers

All Env Id's for the bulk action

appIds
Array of integers

All App Id's for the bulk action (alternative to includes/excludes by name)

projectIds
Array of integers

All Project Id's for the bulk action

Responses

Request samples

Content type
application/json
{
  • "includes": {
    },
  • "excludes": {
    },
  • "envIds": [
    ],
  • "appIds": [
    ],
  • "projectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": [
    ],
  • "failure": [
    ],
  • "successful": [
    ]
}

Bulk Deploy Applications

Bulk Triggers deployment of applications

Request Body schema: application/json
required

A JSON object containing information for bulk deployment.

object (NameIncludesExcludes)
object (NameIncludesExcludes)
envIds
required
Array of integers

All Env Id's for the bulk deployment

appIds
Array of integers

All App Id's for the bulk deployment (alternative to includes/excludes by name)

projectIds
Array of integers

All Project Id's for the bulk deployment

artifactId
integer

ID of the CI artifact to be deployed

releaseId
integer

ID of the release to be deployed

deploymentStrategy
string

Deployment strategy to use (e.g., blue-green, canary, recreate)

Responses

Request samples

Content type
application/json
{
  • "includes": {
    },
  • "excludes": {
    },
  • "envIds": [
    ],
  • "appIds": [
    ],
  • "projectIds": [
    ],
  • "artifactId": 0,
  • "releaseId": 0,
  • "deploymentStrategy": "string"
}

Response samples

Content type
application/json
{
  • "message": [
    ],
  • "failure": [
    ],
  • "successful": [
    ]
}

Bulk Trigger Application Builds

Bulk Triggers build of applications

Request Body schema: application/json
required

A JSON object containing information for bulk build trigger.

object (NameIncludesExcludes)
object (NameIncludesExcludes)
appIds
Array of integers

All App Id's for the bulk build trigger (alternative to includes/excludes by name)

projectIds
Array of integers

All Project Id's for the bulk build trigger

ciPipelineId
required
integer

ID of the CI pipeline to trigger builds for

Responses

Request samples

Content type
application/json
{
  • "includes": {
    },
  • "excludes": {
    },
  • "appIds": [
    ],
  • "projectIds": [
    ],
  • "ciPipelineId": 0
}

Response samples

Content type
application/json
{
  • "message": [
    ],
  • "failure": [
    ],
  • "successful": [
    ]
}

Bulk Edit Applications

Bulk Updates (Edit) all impacted apps. This endpoint can be used for bulk editing application configurations like deployment templates, configmaps, and secrets.

Request Body schema: application/json
required

A JSON object containing information about update changes and by which apps will be filtered for bulk editing.

apiVersion
string

Api version from url

kind
string

Kind

object (BulkUpdatePayload)

Responses

Request samples

Content type
application/json
{
  • "apiVersion": [
    ],
  • "kind": [
    ],
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "deploymentTemplate": {
    },
  • "configMap": {
    },
  • "secret": {
    }
}

SSO Configuration

Manage Single Sign-On (SSO) provider configurations.

Create SSO Login Configuration

Request Body schema: application/json
required

SSO Login Configuration object

name
required
string

Type of auth ie google/github

label
string or null
url
required
string or null <url>

Devtron Dashboard Url

config
required
object

Configuration for the SSO provider (Dex connector config). Structure varies.

active
required
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Update SSO Login Configuration

Request Body schema: application/json
required

SSO Login Configuration object

name
required
string

Type of auth ie google/github

label
string or null
url
required
string or null <url>

Devtron Dashboard Url

config
required
object

Configuration for the SSO provider (Dex connector config). Structure varies.

active
required
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get All SSO Login Configurations

Responses

Response samples

Content type
application/json
[]

Get SSO Login Configuration by ID

path Parameters
id
required
integer <int32>

Identifier (typically integer ID).

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{}

Get SSO Login Configuration by Name

query Parameters
name
required
string

Name of the SSO configuration.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{}

User Management

Operations related to user accounts (CRUD, listing, bulk actions).

List Users (V2 - Paginated, Filtered)

query Parameters
searchKey
string

Search term.

sortOrder
string
Enum: "ASC" "DESC"

Sort order (ASC or DESC).

sortBy
string
Enum: "email_id" "last_login"

Field to sort users by (e.g., email_id, last_login).

offset
integer <int32> >= 0

Offset for pagination.

size
integer <int32> >= 1
Default: 20

Number of items per page.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "totalCount": 0
}

Create User (V2)

Request Body schema: application/json
required

User Information object

id
integer <int32>

User ID. Should not be set for new user creation if auto-generated. Not allowed to be system-admin-userid (1 or 2) by validation.

email_id
required
string <email>

User's email address. Cannot be system admin user email by validation.

roles
Array of strings or null

List of direct roles assigned to the user (deprecated in favor of roleFilters and userRoleGroups).

Array of objects (RoleFilter)
groups
Array of strings or null

Deprecated field for user groups. Use userRoleGroups instead.

Array of objects or null (UserRoleGroup)
superAdmin
boolean

Indicates if the user has super admin privileges.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "accessToken": "string",
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true,
  • "lastLoginTime": "2019-08-24T14:15:22Z"
}

Update User (V2)

Request Body schema: application/json
required

User Information object

id
integer <int32>

User ID. Should not be set for new user creation if auto-generated. Not allowed to be system-admin-userid (1 or 2) by validation.

email_id
required
string <email>

User's email address. Cannot be system admin user email by validation.

roles
Array of strings or null

List of direct roles assigned to the user (deprecated in favor of roleFilters and userRoleGroups).

Array of objects (RoleFilter)
groups
Array of strings or null

Deprecated field for user groups. Use userRoleGroups instead.

Array of objects or null (UserRoleGroup)
superAdmin
boolean

Indicates if the user has super admin privileges.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "accessToken": "string",
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true,
  • "lastLoginTime": "2019-08-24T14:15:22Z"
}

List All Users (V1)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create User

Request Body schema: application/json
required

User Information object

id
integer <int32>

User ID. Should not be set for new user creation if auto-generated. Not allowed to be system-admin-userid (1 or 2) by validation.

email_id
required
string <email>

User's email address. Cannot be system admin user email by validation.

roles
Array of strings or null

List of direct roles assigned to the user (deprecated in favor of roleFilters and userRoleGroups).

Array of objects (RoleFilter)
groups
Array of strings or null

Deprecated field for user groups. Use userRoleGroups instead.

Array of objects or null (UserRoleGroup)
superAdmin
boolean

Indicates if the user has super admin privileges.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "accessToken": "string",
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true,
  • "lastLoginTime": "2019-08-24T14:15:22Z"
}

Update User

Request Body schema: application/json
required

User Information object

id
integer <int32>

User ID. Should not be set for new user creation if auto-generated. Not allowed to be system-admin-userid (1 or 2) by validation.

email_id
required
string <email>

User's email address. Cannot be system admin user email by validation.

roles
Array of strings or null

List of direct roles assigned to the user (deprecated in favor of roleFilters and userRoleGroups).

Array of objects (RoleFilter)
groups
Array of strings or null

Deprecated field for user groups. Use userRoleGroups instead.

Array of objects or null (UserRoleGroup)
superAdmin
boolean

Indicates if the user has super admin privileges.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "accessToken": "string",
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true,
  • "lastLoginTime": "2019-08-24T14:15:22Z"
}

Get User by ID

path Parameters
id
required
integer <int32>

Identifier (typically integer ID).

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "accessToken": "string",
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true,
  • "lastLoginTime": "2019-08-24T14:15:22Z"
}

Delete User by ID

path Parameters
id
required
integer <int32>

Identifier (typically integer ID).

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get User by ID (V2)

path Parameters
id
required
integer <int32>

Identifier (typically integer ID).

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email_id": "user@example.com",
  • "roles": [
    ],
  • "accessToken": "string",
  • "roleFilters": [
    ],
  • "groups": [
    ],
  • "userRoleGroups": [
    ],
  • "superAdmin": true,
  • "lastLoginTime": "2019-08-24T14:15:22Z"
}

Bulk Delete Users

Responses

Response samples

Content type
application/json
{
  • "success": true
}

List All Detailed Users

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Role Group Management

Operations related to user role groups (CRUD, listing, bulk actions).

List Role Groups (V2 - Paginated, Filtered)

query Parameters
searchKey
string

Search term.

sortOrder
string
Enum: "ASC" "DESC"

Sort order (ASC or DESC).

sortBy
string
Value: "name"

Field to sort role groups by (e.g., name).

offset
integer <int32> >= 0

Offset for pagination.

size
integer <int32> >= 1
Default: 20

Number of items per page.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "roleGroups": [
    ],
  • "totalCount": 0
}

Create Role Group (V2)

Request Body schema: application/json
required

Role Group object

name
required
string

Name of the Role group

description
string or null

Descrition fo Role group

required
Array of objects (RoleFilter)

Role filters

superAdmin
boolean

Indicates if this role group grants super admin privileges.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

Update Role Group (V2)

Request Body schema: application/json
required

Role Group object

name
required
string

Name of the Role group

description
string or null

Descrition fo Role group

required
Array of objects (RoleFilter)

Role filters

superAdmin
boolean

Indicates if this role group grants super admin privileges.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

List All Role Groups (V1)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Role Group

Request Body schema: application/json
required

Role Group object

name
required
string

Name of the Role group

description
string or null

Descrition fo Role group

required
Array of objects (RoleFilter)

Role filters

superAdmin
boolean

Indicates if this role group grants super admin privileges.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

Update Role Group

Request Body schema: application/json
required

Role Group object

name
required
string

Name of the Role group

description
string or null

Descrition fo Role group

required
Array of objects (RoleFilter)

Role filters

superAdmin
boolean

Indicates if this role group grants super admin privileges.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

Get Role Group by ID

path Parameters
id
required
integer <int32>

Identifier (typically integer ID).

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

Delete Role Group by ID

path Parameters
id
required
integer <int32>

Identifier (typically integer ID).

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get Role Group by ID (V2)

path Parameters
id
required
integer <int32>

Identifier (typically integer ID).

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

List All Detailed Role Groups

Responses

Response samples

Content type
application/json
{
  • "roleGroups": [
    ],
  • "totalCount": 0
}

Search Role Groups by Name

query Parameters
name
required
string

Name of the role group to search for.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "roleFilters": [
    ],
  • "superAdmin": true
}

Bulk Delete Role Groups

Responses

Response samples

Content type
application/json
{
  • "success": true
}

RBAC

Operations related to Role-Based Access Control, like fetching default roles.

Get All Default Roles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Authentication

Core authentication endpoints including login, token refresh, and auth verification.

User Login

Authenticates a user and returns a session token.

Request Body schema: application/json
required

Username and password for login.

username
required
string

Username

password
required
string <password>

Password

Responses

Request samples

Content type
application/json
{
  • "username": "admin",
  • "password": "password123"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Refresh Session Token

Handles token refresh (details depend on OIDC/OAuth flow).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": { },
  • "errors": [
    ]
}

Verify Authentication Status

Responses

Response samples

Content type
application/json
true

Verify Authentication Status (V2)

Responses

Response samples

Content type
application/json
{
  • "isSuperAdmin": true,
  • "isVerified": true,
  • "emailId": "string"
}

Check Logged-in User's Roles

query Parameters
appName
string

Optional application name to filter roles for.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "role": "string",
  • "roles": [
    ],
  • "superAdmin": true
}

OIDC Login Redirect (Informational)

Initiates OIDC login flow. Handled by the OIDC client library.

Responses

OIDC Login Redirect (Informational - Alternate Path)

Initiates OIDC login flow. Handled by the OIDC client library.

Responses

OIDC Callback (Informational)

Handles the callback from the OIDC provider. Handled by the OIDC client library.

Responses

Dex Proxy (Informational)

Proxies requests to the Dex IdP. Handled by the Dex proxy mechanism.

path Parameters
path
required
string

Path to be proxied to Dex.

header Parameters
token
required
string

Authentication token.

Responses

Policy Management

Endpoints for managing policies.

Add Default Policy and Roles

Creates default policies and roles based on team, app, and environment. This is a specialized endpoint.

query Parameters
team
required
string

Project Id

app
required
string

Application Id

env
required
string

Environment Id

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": { },
  • "errors": [
    ]
}

Sync Orchestrator to Casbin

Synchronizes policies from orchestrator to Casbin. Requires admin privileges.

Responses

Response samples

Content type
application/json
true

Update Trigger Policy for Terminal Access

Updates trigger policies related to terminal access. Requires global update privileges.

Responses

Response samples

Content type
application/json
"string"

Cache Management

Endpoints for managing authentication and authorization caches.

Get Role Cache Dump

Retrieves a dump of the role cache. Requires super admin privileges.

Responses

Response samples

Content type
application/json
{ }

Invalidate Role Cache

Clears the role cache. Requires super admin privileges.

Responses

Response samples

Content type
application/json
"string"

Cluster Environment

Operations related to clusters and environments

List clusters with their environments

Provides a list of all clusters and the environments within each.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List environments for a specific cluster

Provides a list of all environments for a given cluster ID.

path Parameters
cluster_id
required
integer

ID of the cluster

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cluster Management

Operations related to cluster creation, update, and validation

Delete Cluster

Delete an existing cluster.

Request Body schema: application/json
required

A JSON object containing the cluster config (primarily ID is used for deletion)

id
integer

Id of the cluster

cluster_name
string

Name of the cluster

server_url
string

Server Url of the cluster

prometheus_url
string

Prometheus Endpoint of cluster

active
boolean
object
object (PrometheusAuthGet)
Array of objects (DefaultClusterComponentGet)
k8sversion
string

K8s version of the cluster

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "cluster_name": "string",
  • "server_url": "string",
  • "prometheus_url": "string",
  • "active": true,
  • "config": {
    },
  • "prometheusAuth": {
    },
  • "defaultClusterComponents": [
    ],
  • "k8sversion": "string"
}

Response samples

Content type
application/json
{
  • "message": "Cluster deleted successfully."
}

Update Cluster

Update an existing cluster's configuration.

Request Body schema: application/json
required

A JSON object containing the cluster config

id
integer

Id of the cluster

cluster_name
string

Name of the cluster

server_url
string

Server Url of the cluster

prometheus_url
string

Prometheus Endpoint of cluster

active
boolean
object
object (PrometheusAuthGet)
Array of objects (DefaultClusterComponentGet)
k8sversion
string

K8s version of the cluster

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "cluster_name": "string",
  • "server_url": "string",
  • "prometheus_url": "string",
  • "active": true,
  • "config": {
    },
  • "prometheusAuth": {
    },
  • "defaultClusterComponents": [
    ],
  • "k8sversion": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "cluster_name": "string",
  • "server_url": "string",
  • "prometheus_url": "string",
  • "active": true,
  • "config": {
    },
  • "prometheusAuth": {
    },
  • "defaultClusterComponents": [
    ],
  • "k8sversion": "string"
}

Get Cluster

Get details of a specific cluster by ID.

query Parameters
id
required
integer

cluster id.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "cluster_name": "string",
  • "server_url": "string",
  • "prometheus_url": "string",
  • "active": true,
  • "config": {
    },
  • "prometheusAuth": {
    },
  • "defaultClusterComponents": [
    ],
  • "k8sversion": "string"
}

List Accessible Clusters

list of clusters accessible to the authenticated user.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": [
    ]
}

Validate Cluster Configuration

Validate a cluster configuration using kubeconfig.

Request Body schema: application/json
required
object (Kubeconfig)

Kube config of target cluster

Responses

Request samples

Content type
application/json
{
  • "kubeconfig": {
    }
}

Response samples

Content type
application/json
{
  • "userInfos": {
    },
  • "id": 0,
  • "cluster_name": "string",
  • "server_url": "string",
  • "prometheus_url": "string",
  • "active": true,
  • "config": {
    },
  • "prometheusAuth": {
    },
  • "defaultClusterComponent": [
    ],
  • "agentInstallationStage": 0,
  • "k8sVersion": "string",
  • "userName": "string",
  • "insecure-skip-tls-verify": true
}

Save Multiple Clusters

Save configurations for multiple clusters.

Request Body schema: application/json
Array
object
id
integer

Cluster Id

cluster_name
required
string

Name of the cluster

server_url
required
string

Server Url of the cluster

prometheus_url
string

Prometheus Endpoint of the cluster

active
boolean
object
object (PrometheusAuthAdd)
Array of objects (DefaultClusterComponentAdd)
agentInstallationStage
integer
k8sVersion
string

K8s version of the cluster

userName
string
insecure-skip-tls-verify
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Environment Management

Operations for creating, updating, and deleting environments

Create Environment

Create a new environment within a cluster.

Request Body schema: application/json
required

Environment details

environment_name
required
string <= 50 characters

Name of the Environment

cluster_id
required
integer

Id of the target Cluster

active
boolean
Default: true
default
boolean
Default: false
prometheus_endpoint
string

Prometheus Endpoint of cluster

namespace
string <= 50 characters

Name of the Namespace which will point to environment

isClusterCdActive
boolean
description
string <= 40 characters
isVirtualEnvironment
boolean
Default: false
allowedDeploymentTypes
Array of strings
Items Enum: "helm" "argo_cd"

Responses

Request samples

Content type
application/json
{
  • "environment_name": "string",
  • "cluster_id": 0,
  • "active": true,
  • "default": false,
  • "prometheus_endpoint": "string",
  • "namespace": "string",
  • "isClusterCdActive": true,
  • "description": "string",
  • "isVirtualEnvironment": false,
  • "allowedDeploymentTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "environment_name": "string",
  • "cluster_id": 0,
  • "cluster_name": "string",
  • "active": true,
  • "default": true,
  • "prometheus_endpoint": "string",
  • "namespace": "string",
  • "isClusterCdActive": true,
  • "environmentIdentifier": "string",
  • "description": "string",
  • "appCount": 0,
  • "isVirtualEnvironment": true,
  • "allowedDeploymentTypes": [
    ]
}

Update Environment

Update an existing environment.

Request Body schema: application/json
required

Environment details to update

id
required
integer
environment_name
required
string <= 50 characters

Name of the Environment

cluster_id
required
integer

Id of the target Cluster

active
boolean
default
boolean
prometheus_endpoint
string

Prometheus Endpoint of cluster

namespace
string <= 50 characters

Name of the Namespace pointing to environment

isClusterCdActive
boolean
description
string <= 40 characters
isVirtualEnvironment
boolean
allowedDeploymentTypes
Array of strings
Items Enum: "helm" "argo_cd"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "environment_name": "string",
  • "cluster_id": 0,
  • "active": true,
  • "default": true,
  • "prometheus_endpoint": "string",
  • "namespace": "string",
  • "isClusterCdActive": true,
  • "description": "string",
  • "isVirtualEnvironment": true,
  • "allowedDeploymentTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "environment_name": "string",
  • "cluster_id": 0,
  • "cluster_name": "string",
  • "active": true,
  • "default": true,
  • "prometheus_endpoint": "string",
  • "namespace": "string",
  • "isClusterCdActive": true,
  • "environmentIdentifier": "string",
  • "description": "string",
  • "appCount": 0,
  • "isVirtualEnvironment": true,
  • "allowedDeploymentTypes": [
    ]
}

Get Environment by ID

Get detailed information for a specific environment by its ID.

query Parameters
id
required
integer

ID of the environment

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "environment_name": "string",
  • "cluster_id": 0,
  • "cluster_name": "string",
  • "active": true,
  • "default": true,
  • "prometheus_endpoint": "string",
  • "namespace": "string",
  • "isClusterCdActive": true,
  • "environmentIdentifier": "string",
  • "description": "string",
  • "appCount": 0,
  • "isVirtualEnvironment": true,
  • "allowedDeploymentTypes": [
    ]
}

Delete Environment (via POST)

Delete an existing environment using POST method.

Request Body schema: application/json
required

A JSON object containing the env config (primarily ID is used for deletion)

id
integer
environment_name
string

Name of the Environment

cluster_id
integer

Id of the target Cluster

cluster_name
string

Name of the cluster

active
boolean
default
boolean
prometheus_endpoint
string

Prometheus Endpoint of cluster

namespace
string

Name of the Namespace pointing to environment

isClusterCdActive
boolean
environmentIdentifier
string
description
string
appCount
integer
isVirtualEnvironment
boolean
allowedDeploymentTypes
Array of strings
Items Enum: "helm" "argo_cd"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "environment_name": "string",
  • "cluster_id": 0,
  • "cluster_name": "string",
  • "active": true,
  • "default": true,
  • "prometheus_endpoint": "string",
  • "namespace": "string",
  • "isClusterCdActive": true,
  • "environmentIdentifier": "string",
  • "description": "string",
  • "appCount": 0,
  • "isVirtualEnvironment": true,
  • "allowedDeploymentTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Environment deleted successfully."
}

ChangeChartType

Patch Application Environment

change the deployment template for an app and environment

Request Body schema: application/json
envId
integer

Environment Id

appId
integer

Application Id

targetChartRefId
integer

Chart ref Id of template

Responses

Request samples

Content type
application/json
{
  • "envId": 0,
  • "appId": 0,
  • "targetChartRefId": 0
}

CloneWorkflow (ENT)

Clone Application Workflow

Clones an application workflow from a source environment to a target environment

Request Body schema: application/json
required

A JSON object containing the details required to clone the workflow

appId
integer

ID of the application

appName
string

Name of the application

sourceEnvironmentId
integer

ID of the source environment

sourceEnvironmentName
string

Name of the source environment

targetEnvironmentId
integer

ID of the target environment

targetEnvironmentName
string

Name of the target environment

cloneEnvInSameWorkflow
boolean

Flag indicating if the environment should be cloned in the same workflow

Responses

Request samples

Content type
application/json
{
  • "appId": 0,
  • "appName": "string",
  • "sourceEnvironmentId": 0,
  • "sourceEnvironmentName": "string",
  • "targetEnvironmentId": 0,
  • "targetEnvironmentName": "string",
  • "cloneEnvInSameWorkflow": true
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": "OK",
  • "result": {
    }
}

Get Deployment History (ENT)

Retrieves the deployment history for a specific CD pipeline based on various filter criteria.

Get Deployment History

Retrieves the deployment history for a specific CD pipeline based on various filter criteria.

query Parameters
filterCriteria
required
Array of strings

Filter criteria for deployment history. Example:

  • application/devtron-application|id|1064
  • environment|id|146
  • release|id|203
offset
integer

The starting point for fetching records (pagination).

limit
integer

The number of records to return (pagination).

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": "OK",
  • "result": {
    }
}

Fetch component history

fetch detail of a history on the basis of the history component and it's name

path Parameters
appId
required
integer
pipelineId
required
integer
id
required
integer
query Parameters
historyComponent
required
string
Enum: "DEPLOYMENT_TEMPLATE" "CONFIGMAP" "SECRET" "PIPELINE_STRATEGY"
historyComponentName
string

name of config-map, secret

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "codeEditorValue": {
    }
}

fetch deployed history details list

fetch deployed history details list

path Parameters
appId
required
integer
pipelineId
required
integer
query Parameters
historyComponent
required
string
Enum: "DEPLOYMENT_TEMPLATE" "CONFIGMAP" "SECRET" "PIPELINE_STRATEGY"
historyComponentName
string

name of config-map, secret

baseConfigurationId
required
integer

id of base configuration

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

all deployed configuration history

fetch all deployed configurations history (deployment template, pipeline strategy, configmaps, secrets)

path Parameters
appId
required
integer
pipelineId
required
integer
wfrId
required
integer
header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

K8s Resource

APIs for managing Kubernetes resources (get, create, update, delete, list).

Get Resource Manifest

This API is used for fetching the manifest of a specified Kubernetes resource.

Request Body schema: application/json
required

JSON payload specifying the resource to fetch.

appId
string

Application ID. Used when the request is context-specific to an application.

clusterId
number

Cluster ID. Used when the request is for a direct cluster resource (appId is not supplied).

object (K8sRequestObject)

Responses

Request samples

Content type
application/json
{
  • "appId": "my-app/env-1",
  • "clusterId": 1,
  • "k8sRequest": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Update Resource Manifest

This API is used for editing the manifest of a specified Kubernetes resource.

Request Body schema: application/json
required

JSON payload containing the resource identifier and the patch.

appId
string

Application ID. Used when the request is context-specific to an application.

clusterId
number

Cluster ID. Used when the request is for a direct cluster resource (appId is not supplied).

object (K8sRequestObject)

Responses

Request samples

Content type
application/json
{
  • "appId": "my-app/env-1",
  • "clusterId": 1,
  • "k8sRequest": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Create Resource

This API is used for applying a desired manifest to create a Kubernetes resource.

Request Body schema: application/json
required

JSON payload containing the resource manifest to apply.

appId
string

Application ID. Used when the request is context-specific to an application.

clusterId
number

Cluster ID. Used when the request is for a direct cluster resource (appId is not supplied).

object (K8sRequestObject)

Responses

Request samples

Content type
application/json
{
  • "appId": "my-app/env-1",
  • "clusterId": 1,
  • "k8sRequest": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Delete Resource

This API is used for deleting a specified Kubernetes resource.

Request Body schema: application/json
required

JSON payload specifying the resource to delete.

appId
string

Application ID. Used when the request is context-specific to an application.

clusterId
number

Cluster ID. Used when the request is for a direct cluster resource (appId is not supplied).

object (K8sRequestObject)

Responses

Request samples

Content type
application/json
{
  • "appId": "my-app/env-1",
  • "clusterId": 1,
  • "k8sRequest": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": {
    }
}

Get Resource Events

This API is used for fetching events for Kubernetes resources.

Request Body schema: application/json
optional
appId
string

Application ID. Used when the request is context-specific to an application.

clusterId
number

Cluster ID. Used when the request is for a direct cluster resource (appId is not supplied).

object (K8sRequestObject)

Responses

Request samples

Content type
application/json
{
  • "appId": "my-app/env-1",
  • "clusterId": 1,
  • "k8sRequest": {
    }
}

Get Pod Logs

This API is used for fetching logs for a specified container within a pod.

path Parameters
podName
required
string

Name of the pod.

query Parameters
containerName
required
string

Name of the container within the pod.

appId
string

Application ID.

clusterId
integer

Cluster ID.

namespace
string

Namespace of the pod. Required if clusterId is passed.

follow
boolean
Default: false

Whether to follow the log stream.

sinceSeconds
integer

Return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs.

tailLines
integer

If set, the number of lines from the end of the logs to show.

header Parameters
token
required
string

Authentication token.

Responses

Get Pod Exec Session

This API establishes a session for executing commands in a pod's container (terminal access).

path Parameters
identifier
required
string

Application ID or Cluster ID. Example '2|devtroncd|devtron' or '3'.

namespace
required
string
Example: devtroncd

Namespace of the pod.

pod
required
string
Example: inception-58d44d99fd-tfw4s

Name of the pod.

shell
required
string
Enum: "bash" "sh" "powershell" "cmd"
Example: bash

Shell to invoke.

container
required
string
Example: devtron

Name of the container.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "Op": "stdin",
  • "Data": "ls -l",
  • "SessionID": "unique-session-id-123"
}

Get API Resources

Get all available API resources for a given cluster ID.

path Parameters
clusterId
required
integer <int64>

ID of the cluster.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "apiResources": [
    ],
  • "allowedAll": true
}

List Resources

This API is used for fetching a list of Kubernetes resources based on the request criteria.

Request Body schema: application/json
required

JSON payload specifying the criteria for listing resources.

appId
string

Application ID. Used when the request is context-specific to an application.

clusterId
number

Cluster ID. Used when the request is for a direct cluster resource (appId is not supplied).

object (K8sRequestObject)

Responses

Request samples

Content type
application/json
{
  • "appId": "my-app/env-1",
  • "clusterId": 1,
  • "k8sRequest": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "status": "string",
  • "result": [
    ]
}

Rotates the Pods

This API is used to rotate (restart) pods for the provided resources.

query Parameters
appId
required
string

Application ID.

header Parameters
token
required
string

Authentication token.

Request Body schema: application/json
required

JSON payload specifying the resources for which pods should be rotated.

clusterId
required
number

ID of the cluster where resources reside.

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "clusterId": 1,
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "containsError": false,
  • "responses": [
    ]
}

Apply Resources

This API is used to apply (create or update) Kubernetes resources in a cluster.

Request Body schema: application/json
required

JSON payload containing the manifest of resources to apply.

clusterId
required
number

ID of the cluster where resources will be applied.

manifest
required
string

A string containing one or more Kubernetes resource manifests, separated by '---'.

Responses

Request samples

Content type
application/json
{
  • "clusterId": 1,
  • "manifest": "apiVersion: v1\nkind: ConfigMap\nmetadata:\n name: my-cm\ndata:\n key: value\n---\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: my-app\nspec:\n replicas: 1\n selector:\n matchLabels:\n app: my-app\n template:\n metadata:\n labels:\n app: my-app\n spec:\n containers:\n - name: nginx\n image: nginx\n"
}

Response samples

Content type
application/json
[
  • {
    }
]

Resource Recommendation (ENT)

Operations related to resource recommendations for Kubernetes workloads.

Sync Cluster Resource Recommendations

This API will be used to sync resource recommendations for a cluster

Request Body schema: application/json
required

A JSON object containing the details required to sync cluster resource recommendations

clusterId
required
number

ID of the target cluster

Responses

Request samples

Content type
application/json
{
  • "clusterId": 0
}

Response samples

Content type
application/json
"string"

Get Cluster Resource Recommendation Details

This API will fetch resource recommendations metadata for a cluster

path Parameters
clusterId
required
number

ID of the target cluster

Responses

Response samples

Content type
application/json
{
  • "supportedGVKs": [
    ],
  • "lastScannedOn": "2019-08-24T14:15:22Z"
}

Get Cluster Resource Recommendation List

This API will be used for fetching all workloads and their resource recommendations

Request Body schema: application/json
required

A JSON object containing the details required to fetch cluster resource recommendations

appId
string

Application ID. Used when the request is context-specific to an application.

clusterId
number

Cluster ID. Used when the request is for a direct cluster resource (appId is not supplied).

object (K8sRequestObject)

Responses

Request samples

Content type
application/json
{
  • "appId": "my-app/env-1",
  • "clusterId": 1,
  • "k8sRequest": {
    }
}

Response samples

Content type
application/json
{
  • "headers": [
    ],
  • "data": [
    ]
}

Workflow Management

Create an application workflow

Creates a new workflow for a given application.

Request Body schema: application/json
required
name
string

Name of the workflow.

appId
integer

ID of the application this workflow belongs to.

Array of objects (AppWorkflowMappingDto)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "appId": 0,
  • "tree": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "appId": 0,
  • "tree": [
    ]
}

Delete an application workflow

Deletes an existing workflow for a given application.

path Parameters
app-wf-id
required
integer

ID of the application workflow to delete.

app-id
required
integer

ID of the application.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Devtron Server version

Get Devtron server version information

Responses

Response samples

Content type
application/json
{
  • "gitCommit": "d252aa3e",
  • "buildTime": "2021-12-15T05:44:05Z",
  • "serverMode": "FULL"
}

GitOps Validation

Validate gitops configuration by dry run

Validate gitops configuration by dry run

Request Body schema: application/json
required

A JSON object containing the gitops configuration

id
integer

GitOps Id (null for new configuration)

provider
string

Gitops provider

username
string

Username of GitOps provider

token
string

Authentication token of GitOps provider

gitLabGroupId
string

Group Id of gitLab

gitHubOrgId
string

Group Id of gitHub

host
string

Host of GitOps provider

active
boolean
azureProjectName
string

Project Name of Azure

userId
integer

User Id of GitOps provider

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "provider": "github,gitlabs",
  • "username": "string",
  • "token": "string",
  • "gitLabGroupId": "string",
  • "gitHubOrgId": "string",
  • "host": "string",
  • "active": true,
  • "azureProjectName": "string",
  • "userId": 0
}

Response samples

Content type
application/json
{
  • "successfulStages": [
    ],
  • "validatedOn": "string",
  • "stageErrorMap": [
    ]
}

create/save new configuration and validate them before saving

create/save new configuration and validate them before saving

Request Body schema: application/json
required

A JSON object containing the gitops configuration

id
integer

GitOps Id (null for new configuration)

provider
string

Gitops provider

username
string

Username of GitOps provider

token
string

Authentication token of GitOps provider

gitLabGroupId
string

Group Id of gitLab

gitHubOrgId
string

Group Id of gitHub

host
string

Host of GitOps provider

active
boolean
azureProjectName
string

Project Name of Azure

userId
integer

User Id of GitOps provider

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "provider": "github,gitlabs",
  • "username": "string",
  • "token": "string",
  • "gitLabGroupId": "string",
  • "gitHubOrgId": "string",
  • "host": "string",
  • "active": true,
  • "azureProjectName": "string",
  • "userId": 0
}

Response samples

Content type
application/json
{
  • "successfulStages": [
    ],
  • "validatedOn": "string",
  • "stageErrorMap": [
    ]
}

update configuration and validate them before saving(if last validation is within 30 seconds then do not validate)

update configuration and validate them before saving(if last validation is within 30 seconds then do not validate)

Request Body schema: application/json
required

A JSON object containing the gitops configuration

id
integer

GitOps Id (null for new configuration)

provider
string

Gitops provider

username
string

Username of GitOps provider

token
string

Authentication token of GitOps provider

gitLabGroupId
string

Group Id of gitLab

gitHubOrgId
string

Group Id of gitHub

host
string

Host of GitOps provider

active
boolean
azureProjectName
string

Project Name of Azure

userId
integer

User Id of GitOps provider

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "provider": "github,gitlabs",
  • "username": "string",
  • "token": "string",
  • "gitLabGroupId": "string",
  • "gitHubOrgId": "string",
  • "host": "string",
  • "active": true,
  • "azureProjectName": "string",
  • "userId": 0
}

Response samples

Content type
application/json
{
  • "successfulStages": [
    ],
  • "validatedOn": "string",
  • "stageErrorMap": [
    ]
}

Notifiactions

Returns all notification settings

Returns all notification settings

query Parameters
offset
required
integer

value can be regex search string.

size
required
integer

value can be regex search string.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "configName": "string",
  • "appId": 0,
  • "envId": 0,
  • "pipelineIds": [
    ],
  • "eventTypeIds": [
    ],
  • "pipelineType": "string",
  • "providers": [
    ]
}

Creates a new NotificationSetting

create NotificationSetting api.

Request Body schema: application/json
required

json as request body

id
integer

Unique id

configName
required
string

Unique name of group

appId
integer

app id

envId
integer

env id

pipelineIds
Array of integers
eventTypeIds
Array of integers
pipelineType
string

pipeline type CI or CD

Array of objects (providers)

role filters objects

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "configName": "string",
  • "appId": 0,
  • "envId": 0,
  • "pipelineIds": [
    ],
  • "eventTypeIds": [
    ],
  • "pipelineType": "string",
  • "providers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "configName": "string",
  • "appId": 0,
  • "envId": 0,
  • "pipelineIds": [
    ],
  • "eventTypeIds": [
    ],
  • "pipelineType": "string",
  • "providers": [
    ]
}

Update NotificationSetting

Update NotificationSetting api either recipients or events(trigger/success/failed).

Request Body schema: application/json
required

json as request body

id
integer

Unique id

configName
required
string

Unique name of group

appId
integer

app id

envId
integer

env id

pipelineIds
Array of integers
eventTypeIds
Array of integers
pipelineType
string

pipeline type CI or CD

Array of objects (providers)

role filters objects

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "configName": "string",
  • "appId": 0,
  • "envId": 0,
  • "pipelineIds": [
    ],
  • "eventTypeIds": [
    ],
  • "pipelineType": "string",
  • "providers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "configName": "string",
  • "appId": 0,
  • "envId": 0,
  • "pipelineIds": [
    ],
  • "eventTypeIds": [
    ],
  • "pipelineType": "string",
  • "providers": [
    ]
}

Delete NotificationSetting

delete notification setting.

Request Body schema: application/json
required

json as request body

id
integer

Unique id

configName
required
string

Unique name of group

appId
integer

app id

envId
integer

env id

pipelineIds
Array of integers
eventTypeIds
Array of integers
pipelineType
string

pipeline type CI or CD

Array of objects (providers)

role filters objects

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "configName": "string",
  • "appId": 0,
  • "envId": 0,
  • "pipelineIds": [
    ],
  • "eventTypeIds": [
    ],
  • "pipelineType": "string",
  • "providers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "configName": "string",
  • "appId": 0,
  • "envId": 0,
  • "pipelineIds": [
    ],
  • "eventTypeIds": [
    ],
  • "pipelineType": "string",
  • "providers": [
    ]
}

used to fetch providers(recipients)

recipients fetch by string search, it will return slacks providers and email ids

query Parameters
value
required
string

value can be regex search string.

header Parameters
token
required
string

Authentication token.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

get all NotificationSettingConfig list

get all NotificationSettingConfig list

Responses

Response samples

Content type
application/json
{
  • "slackConfigs": [
    ],
  • "sesConfigs": [
    ]
}

Creates a new NotificationSettingConfig

create NotificationSettingConfig, Slack or SES

Request Body schema: application/json
required

json as request body

channel
required
string
Enum: "slack" "ses"

channel type

Array of objects (configs)

config holds for either slack or ses

Responses

Request samples

Content type
application/json
{
  • "channel": "slack",
  • "configs": [
    ]
}

Response samples

Content type
application/json
{
  • "slackConfigs": [
    ],
  • "sesConfigs": [
    ]
}