> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/api-reference/platform-apis/core-platform/rollback.md).

# Rollback

This contains APIs related to Post Prod Rollback of specific service

## POST /rollback/check

> Verification for rollback eligibility for service

```json
{"openapi":"3.0.1","info":{"title":"Harness NextGen Software Delivery Platform API Reference","version":"3.0"},"tags":[{"name":"Rollback","description":"This contains APIs related to Post Prod Rollback of specific service"}],"servers":[{"url":"https://ng-manager-7b6bb5bdbc-5jxjn/gateway/ng/api"}],"paths":{"/rollback/check":{"post":{"tags":["Rollback"],"summary":"Verification for rollback eligibility for service","operationId":"checkIfInstanceCanBeRolledBack","parameters":[{"name":"accountIdentifier","in":"query","required":true,"schema":{"type":"string"}},{"name":"orgIdentifier","in":"query","schema":{"type":"string"}},{"name":"projectIdentifier","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostProdRollbackRequestDTO"}}},"required":true},"responses":{"default":{"description":"Return details on whether rollback is allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDTOPostProdRollbackCheckDTO"}}}}}}}},"components":{"schemas":{"PostProdRollbackRequestDTO":{"required":["infrastructureMappingId","instanceKey"],"type":"object","properties":{"instanceKey":{"type":"string"},"infrastructureMappingId":{"type":"string"}}},"ResponseDTOPostProdRollbackCheckDTO":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","ERROR"]},"data":{"$ref":"#/components/schemas/PostProdRollbackCheckDTO"},"metaData":{"type":"object"},"correlationId":{"type":"string"}}},"PostProdRollbackCheckDTO":{"type":"object","properties":{"isRollbackAllowed":{"type":"boolean","writeOnly":true},"message":{"type":"string"},"swimLaneInfo":{"$ref":"#/components/schemas/PostProdRollbackSwimLaneInfo"},"rollbackAllowed":{"type":"boolean"}}},"PostProdRollbackSwimLaneInfo":{"type":"object"}}}}
```

## POST /rollback/trigger

> Trigger the rollback for specific service

```json
{"openapi":"3.0.1","info":{"title":"Harness NextGen Software Delivery Platform API Reference","version":"3.0"},"tags":[{"name":"Rollback","description":"This contains APIs related to Post Prod Rollback of specific service"}],"servers":[{"url":"https://ng-manager-7b6bb5bdbc-5jxjn/gateway/ng/api"}],"paths":{"/rollback/trigger":{"post":{"tags":["Rollback"],"summary":"Trigger the rollback for specific service","operationId":"triggerRollback","parameters":[{"name":"accountIdentifier","in":"query","required":true,"schema":{"type":"string"}},{"name":"orgIdentifier","in":"query","schema":{"type":"string"}},{"name":"projectIdentifier","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostProdRollbackRequestDTO"}}},"required":true},"responses":{"default":{"description":"Return status of triggered rollback","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDTOPostProdRollbackResponseDTO"}}}}}}}},"components":{"schemas":{"PostProdRollbackRequestDTO":{"required":["infrastructureMappingId","instanceKey"],"type":"object","properties":{"instanceKey":{"type":"string"},"infrastructureMappingId":{"type":"string"}}},"ResponseDTOPostProdRollbackResponseDTO":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","ERROR"]},"data":{"$ref":"#/components/schemas/PostProdRollbackResponseDTO"},"metaData":{"type":"object"},"correlationId":{"type":"string"}}},"PostProdRollbackResponseDTO":{"type":"object","properties":{"isRollbackTriggered":{"type":"boolean","writeOnly":true},"instanceKey":{"type":"string"},"infraMappingId":{"type":"string"},"planExecutionId":{"type":"string"},"message":{"type":"string"},"rollbackTriggered":{"type":"boolean"}}}}}}
```

## POST /rollback/trigger/v2

> Trigger the rollback for specific service to an environment

```json
{"openapi":"3.0.1","info":{"title":"Harness NextGen Software Delivery Platform API Reference","version":"3.0"},"tags":[{"name":"Rollback","description":"This contains APIs related to Post Prod Rollback of specific service"}],"servers":[{"url":"https://ng-manager-7b6bb5bdbc-5jxjn/gateway/ng/api"}],"paths":{"/rollback/trigger/v2":{"post":{"tags":["Rollback"],"summary":"Trigger the rollback for specific service to an environment","operationId":"triggerRollbackV2","parameters":[{"name":"accountIdentifier","in":"query","required":true,"schema":{"type":"string"}},{"name":"orgIdentifier","in":"query","schema":{"type":"string"}},{"name":"projectIdentifier","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollbackRequestDTO"}}},"required":true},"responses":{"default":{"description":"Return status of triggered rollback","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDTORollbackResponseDTO"}}}}}}}},"components":{"schemas":{"RollbackRequestDTO":{"required":["envIdentifier","serviceIdentifier"],"type":"object","properties":{"serviceIdentifier":{"type":"string"},"envIdentifier":{"type":"string"},"environmentType":{"type":"string","enum":["PreProduction","Production"]},"infraIdentifier":{"type":"string"},"artifact":{"type":"string"},"chartVersion":{"type":"string"}}},"ResponseDTORollbackResponseDTO":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","ERROR"]},"data":{"$ref":"#/components/schemas/RollbackResponseDTO"},"metaData":{"type":"object"},"correlationId":{"type":"string"}}},"RollbackResponseDTO":{"type":"object","properties":{"isRollbackTriggered":{"type":"boolean","writeOnly":true},"instanceKey":{"type":"string"},"infraMappingId":{"type":"string"},"planExecutionId":{"type":"string"},"message":{"type":"string"},"serviceIdentifier":{"type":"string"},"envIdentifier":{"type":"string"},"environmentType":{"type":"string"},"infraIdentifier":{"type":"string"},"rollbackTriggered":{"type":"boolean"}}}}}}
```

## POST /rollback/trigger/v3

> Trigger rollback for multiple targets using the same semantics as v2 (latest pipeline execution group per target). Failures are reported per target without failing the entire batch.

```json
{"openapi":"3.0.1","info":{"title":"Harness NextGen Software Delivery Platform API Reference","version":"3.0"},"tags":[{"name":"Rollback","description":"This contains APIs related to Post Prod Rollback of specific service"}],"servers":[{"url":"https://ng-manager-7b6bb5bdbc-5jxjn/gateway/ng/api"}],"paths":{"/rollback/trigger/v3":{"post":{"tags":["Rollback"],"summary":"Trigger rollback for multiple targets using the same semantics as v2 (latest pipeline execution group per target). Failures are reported per target without failing the entire batch.","operationId":"triggerRollbackV3","parameters":[{"name":"accountIdentifier","in":"query","required":true,"schema":{"type":"string"}},{"name":"orgIdentifier","in":"query","schema":{"type":"string"}},{"name":"projectIdentifier","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRollbackRequestDTO"}}},"required":true},"responses":{"default":{"description":"Return per-target rollback status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDTOBatchRollbackResponseDTO"}}}}}}}},"components":{"schemas":{"BatchRollbackRequestDTO":{"required":["targets"],"type":"object","properties":{"targets":{"maxItems":50,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/RollbackRequestDTO"}}}},"RollbackRequestDTO":{"required":["envIdentifier","serviceIdentifier"],"type":"object","properties":{"serviceIdentifier":{"type":"string"},"envIdentifier":{"type":"string"},"environmentType":{"type":"string","enum":["PreProduction","Production"]},"infraIdentifier":{"type":"string"},"artifact":{"type":"string"},"chartVersion":{"type":"string"}}},"ResponseDTOBatchRollbackResponseDTO":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","ERROR"]},"data":{"$ref":"#/components/schemas/BatchRollbackResponseDTO"},"metaData":{"type":"object"},"correlationId":{"type":"string"}}},"BatchRollbackResponseDTO":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/RollbackResponseDTO"}},"totalRollbacksTriggered":{"type":"integer","format":"int32"},"totalRollbacksFailed":{"type":"integer","format":"int32"}}},"RollbackResponseDTO":{"type":"object","properties":{"isRollbackTriggered":{"type":"boolean","writeOnly":true},"instanceKey":{"type":"string"},"infraMappingId":{"type":"string"},"planExecutionId":{"type":"string"},"message":{"type":"string"},"serviceIdentifier":{"type":"string"},"envIdentifier":{"type":"string"},"environmentType":{"type":"string"},"infraIdentifier":{"type":"string"},"rollbackTriggered":{"type":"boolean"}}}}}}
```
