Harness

CustomDeployment

This contains APIs related to Custom Deployment

Gets Custom Deployment Entity References

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Request Body schema:
required

Custom Deployment Yaml Request DTO containing entityYaml

entityYaml
required
string
Responses
400

Bad Request

500

Internal Server Error

default

Returns all entity references in the custom deployment template.

post/ng/api/customDeployment/get-references
Request samples
{
  • "entityYaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Custom Deployment Expression Variables

Securityx-api-key
Request
Request Body schema:
required

Custom Deployment Yaml Request DTO containing entityYaml

entityYaml
required
string
Responses
400

Bad Request

500

Internal Server Error

default

Returns all Variables used that are valid to be used as expression in template.

post/ng/api/customDeployment/expression-variables
Request samples
{
  • "entityYaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Infra Variables from a Custom Deployment Template by identifier

Securityx-api-key
Request
path Parameters
templateIdentifier
required
string

Custom Deployment 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.

versionLabel
string

Version Label

deleted
boolean
Default: false

Specifies whether Template is deleted or not

Responses
400

Bad Request

500

Internal Server Error

default

The saved Custom Deployment Infra Variables

get/ng/api/customDeployment/variables/{templateIdentifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Return the updated yaml for infrastructure based on Deployment template
Securityx-api-key 
Request 
path Parameters
infraIdentifier
required
string
Infrastructure 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.


 
Request Body schema: 
required
YAML


yaml
required
string
 
Responses 
400
Bad Request


500
Internal Server Error


default
Return the updated yaml for infrastructure based on Deployment template


post/ng/api/customDeployment/get-updated-Yaml/{infraIdentifier}
Request samples 
{
  • "yaml": "string"
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
This validates whether Infrastructure is valid or not
Securityx-api-key 
Request 
path Parameters
infraIdentifier
required
string
Infrastructure 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.


 
envIdentifier
string
Environment Identifier for the entity


 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns if the infra is valid or not.


get/ng/api/customDeployment/validate-infrastructure/{infraIdentifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to Environments