EnvironmentGroup

This contains APIs related to EnvironmentGroup. Please enable Feature flag ENV_GROUP to use them

Create an Environment Group

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Request Body schema:

Details of the Environment Group to be created

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

identifier
string^[a-zA-Z_][0-9a-zA-Z_$]{0,63}$

Identifier of the Environment Group.

color
string

Color of the Environment Group.

yaml
required
string

Yaml of the Environment Group.

Responses
400

Bad Request

500

Internal Server Error

default

If the YAML is valid, returns created Environment Group. If not, it sends what is wrong with the YAML

post/ng/api/environmentGroup
Request samples
{
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "identifier": "string",
  • "color": "string",
  • "yaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete en Environment Group by Identifier

SecurityApiKey
Request
path Parameters
envGroupIdentifier
required
string

Environment Group Identifier for the entity

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

rootFolder
string

Path to the root folder of the Entity.

filePath
string

File Path of the Entity.

commitMsg
string

Commit Message to use for the merge commit.

lastObjectId
string

Last Object Id

header Parameters
If-Match
string
Responses
400

Bad Request

500

Internal Server Error

default

Returns true if the Environment Group is deleted

delete/ng/api/environmentGroup/{envGroupIdentifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets an Environment Group by identifier

SecurityApiKey
Request
path Parameters
envGroupIdentifier
required
string

Environment Group Identifier for the entity

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

deleted
boolean
Default: false

Specify whether Environment is deleted or not

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Responses
400

Bad Request

500

Internal Server Error

default

The saved Environment Group

get/ng/api/environmentGroup/{envGroupIdentifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Environment Group list for a Project

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

envGroupIdentifiers
Array of strings
searchTerm
string

The word to be searched and included in the list response

page
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

size
integer <int32>
Default: 25

Results per page

sort
Array of strings

Sort criteria for the elements.

filterIdentifier
string

Filter identifier

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Request Body schema:

This is the body for the filter properties for listing Environment Groups

Responses
400

Bad Request

500

Internal Server Error

default

Returns the list of Environment Group for a Project

post/ng/api/environmentGroup/list
Request samples
No sample
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update an Environment Group by Identifier

SecurityApiKey
Request
path Parameters
envGroupIdentifier
required
string

Environment Group Identifier for the entity

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

rootFolder
string

Path to the root folder of the Entity.

filePath
string

Path to the root folder of the Entity.

commitMsg
string

Commit Message to use for the merge commit.

lastObjectId
string

Last Object Id

resolvedConflictCommitId
string

If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved

baseBranch
string

Name of the default branch.

connectorRef
string

Identifier of Connector needed for CRUD operations on the respective Entity

header Parameters
If-Match
string
Request Body schema:

Details of the Environment Group to be updated

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

identifier
string^[a-zA-Z_][0-9a-zA-Z_$]{0,63}$

Identifier of the Environment Group.

color
string

Color of the Environment Group.

yaml
required
string

Yaml of the Environment Group.

Responses
400

Bad Request

500

Internal Server Error

default

Returns the updated Environment Group

put/ng/api/environmentGroup/{envGroupIdentifier}
Request samples
{
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "identifier": "string",
  • "color": "string",
  • "yaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}