# Start One Outage Simulation

**POST /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/outageSimulation**

Starts a cluster outage simulation.

[Cluster Outage Simulation](https://dochub.mongodb.org/core/test-regional-outage)

## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters

#### Path parameters
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
- **clusterName** (string)
  Human-readable label that identifies the cluster to undergo an outage simulation.

#### Query parameters
- **envelope** (boolean)
  Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
- **pretty** (boolean)
  Flag that indicates whether the response body should be in the prettyprint format.

## Body parameters
Content-type: application/json
Describes the outage simulation.
- **outageFilters** (array[object])
  List of settings that specify the type of cluster outage simulation.

## Responses
### 200: OK

#### Body Parameters: application/json (object)
- **clusterName** (string)
  Human-readable label that identifies the cluster that undergoes outage simulation.
- **expirationDate** (string(date-time))
  Date and time when MongoDB Cloud expires the outage simulation. This parameter expresses its value in the ISO 8601 timestamp format in UTC. If not provided, defaults to 3 days from the start date.
- **groupId** (string)
  Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.
- **id** (string)
  Unique 24-hexadecimal character string that identifies the outage simulation.
- **outageFilters** (array[object])
  List of settings that specify the type of cluster outage simulation.
- **startRequestDate** (string(date-time))
  Date and time when MongoDB Cloud started the regional outage simulation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- **state** (string)
  Phase of the outage simulation.

| State       | Indication |
|-------------|------------|
| `START_REQUESTED`    | User has requested cluster outage simulation.|
| `STARTING`           | MongoDB Cloud is starting cluster outage simulation.|
| `SIMULATING`         | MongoDB Cloud is simulating cluster outage.|
| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|
| `RECOVERING`         | MongoDB Cloud is recovering the cluster from the simulated outage.|
| `COMPLETE`           | MongoDB Cloud has completed the cluster outage simulation.|

### 400: Bad Request.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 401: Unauthorized.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 403: Forbidden.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 404: Not Found.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 500: Internal Server Error.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.


[Powered by Bump.sh](https://bump.sh)