Environments

This contains APIs related to Environments

Create an Environment

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

Details of the Environment to be created

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

identifier
string

Identifier of the Environment.

object

Tags

name
string

Name of the Environment.

description
string

Description of the entity

color
string

Color of the Environment.

type
string

Specify the environment type whether production or Preproduction.

Enum: "PreProduction" "Production"
yaml
string

Yaml of this entity.

Responses
400

Bad Request

500

Internal Server Error

default

Returns the created Environment

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

Delete an Environment by identifier

SecurityApiKey
Request
path Parameters
environmentIdentifier
required
string

Environment Identifier for the entity

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

header Parameters
If-Match
string
Responses
400

Bad Request

500

Internal Server Error

default

Returns true if the Environment is deleted

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

Gets an Environment by identifier

SecurityApiKey
Request
path Parameters
environmentIdentifier
required
string

Environment Identifier for the entity

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

deleted
boolean
Default: false

Specify whether Environment is deleted or not

Responses
400

Bad Request

500

Internal Server Error

default

The saved Environment

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

Gets Environment Access list

SecurityApiKey
Request
query Parameters
page
integer <int32>
Default: 0

page

size
integer <int32>
Default: 100

size

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

searchTerm
string

The word to be searched and included in the list response

envIdentifiers
Array of strings

List of EnvironmentIds

sort
Array of strings

Specifies sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order

Responses
400

Bad Request

500

Internal Server Error

default

Returns the list of Environments for a Project that are accessible

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

Gets Environment list for a project

SecurityApiKey
Request
query Parameters
page
integer <int32>
Default: 0

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

size
integer <int32>
Default: 100

Results per page

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

searchTerm
string

The word to be searched and included in the list response

envIdentifiers
Array of strings

List of EnvironmentIds

sort
Array of strings

Specifies sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order

Responses
400

Bad Request

500

Internal Server Error

default

Returns the list of Environments for a Project

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

Update an Environment by identifier

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

header Parameters
If-Match
string
Request Body schema:

Details of the Environment to be updated

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

identifier
string

Identifier of the Environment.

object

Tags

name
string

Name of the Environment.

description
string

Description of the entity

color
string

Color of the Environment.

type
string

Specify the environment type whether production or Preproduction.

Enum: "PreProduction" "Production"
yaml
string

Yaml of this entity.

Responses
400

Bad Request

500

Internal Server Error

default

Returns the updated Environment

put/ng/api/environmentsV2
Request samples
{
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "identifier": "string",
  • "tags": {
    },
  • "name": "string",
  • "description": "string",
  • "color": "string",
  • "type": "PreProduction",
  • "yaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Upsert an Environment by identifier

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

header Parameters
If-Match
string
Request Body schema:

Details of the Environment to be updated

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

identifier
string

Identifier of the Environment.

object

Tags

name
string

Name of the Environment.

description
string

Description of the entity

color
string

Color of the Environment.

type
string

Specify the environment type whether production or Preproduction.

Enum: "PreProduction" "Production"
yaml
string

Yaml of this entity.

Responses
400

Bad Request

500

Internal Server Error

default

Returns the updated Environment

put/ng/api/environmentsV2/upsert
Request samples
{
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "identifier": "string",
  • "tags": {
    },
  • "name": "string",
  • "description": "string",
  • "color": "string",
  • "type": "PreProduction",
  • "yaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}