Harness

Freeze CRUD

This contains APIs related to Freeze CRUD

Create a Freeze

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

Freeze YAML

string
Responses
400

Bad Request

500

Internal Server Error

default

Returns the created Freeze Config

post/ng/api/freeze
Request samples

Sample Freeze YAML

"freeze:\n name: Sample Freeze\n identifier: Sample_Freeze\n entityConfigs:\n - name: Rule 1\n entities:\n - type: Service\n filterType: All\n - type: EnvType\n filterType: All\n status: Disabled\n orgIdentifier: org1\n projectIdentifier: Project1\n windows:\n - timeZone: Asia/Calcutta\n startTime: 2023-02-20 11:28 AM\n duration: 30m"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get a Freeze

Securityx-api-key
Request
path Parameters
freezeIdentifier
required
string

Freeze Identifier.

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

Returns the created Freeze Config

get/ng/api/freeze/{freezeIdentifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Updates a Freeze
Securityx-api-key 
Request 
path Parameters
freezeIdentifier
required
string
Freeze Identifier.


 
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
Freeze YAML


string
 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns the updated Freeze Config


put/ng/api/freeze/{freezeIdentifier}
Request samples 
Sample Freeze YAML


"freeze:\n  name: Sample Freeze\n  identifier: Sample_Freeze\n  entityConfigs:\n    - name: Rule 1\n      entities:\n        - type: Service\n          filterType: All\n        - type: EnvType\n          filterType: All\n  status: Disabled\n  orgIdentifier: org1\n  projectIdentifier: project1\n  windows:\n    - timeZone: Asia/Calcutta\n      startTime: 2023-02-20 11:28 AM\n      duration: 33m\n  description: \"\""
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Delete a Freeze
Securityx-api-key 
Request 
path Parameters
freezeIdentifier
required
string
Freeze Identifier.


 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns the created Freeze Config


delete/ng/api/freeze/{freezeIdentifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Delete many Freezes
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: 
List of Freeze Identifiers


 Array 
string
 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns the created Freeze Config


post/ng/api/freeze/delete
Request samples 
[
  • "string"
]
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets Freeze list
Securityx-api-key 
Request 
query Parameters
page
integer <int32> 
 Default:  0
Page Index of the results to fetch.Default Value: 0


 
size
integer <int32> 
 Default:  10
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.


 
Request Body schema: 
This contains details of Freeze filters


freezeIdentifiers
Array of strings
 
sort
Array of strings
 
freezeStatus
string
 Enum: "Enabled" "Disabled"  
startTime
integer <int64> 
 
endTime
integer <int64> 
 
searchTerm
string
 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns the list of Freeze for a Project


post/ng/api/freeze/list
Request samples 
{
  • "freezeIdentifiers": [
    ],
  • "sort": [
    ],
  • "freezeStatus": "Enabled",
  • "startTime": 0,
  • "endTime": 0,
  • "searchTerm": "string"
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get list of freeze acted on a frozen execution
Securityx-api-key 
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.


 
planExecutionId
required
string
 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns list of freeze acted on a frozen execution


get/ng/api/freeze/getFrozenExecutionDetails
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get Global Freeze Yaml
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.


 
Responses 
400
Bad Request


500
Internal Server Error


default
Get Global Freeze Yaml


get/ng/api/freeze/getGlobalFreeze
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Create Global Freeze
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
Freeze YAML


string
 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns the created Global Freeze Config


post/ng/api/freeze/manageGlobalFreeze
Request samples 
"string"
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Update the status of Freeze to active or inactive
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.


 
status
required
string
Freeze YAML


 Enum: "Enabled" "Disabled"  
Request Body schema: 
Comma seperated List of Freeze Identifiers


 Array 
string
 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns the created Freeze Config


post/ng/api/freeze/updateFreezeStatus
Request samples 
[
  • "string"
]
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to Freeze Evaluation