# Return One Event from One Project

**GET /api/atlas/v2/groups/{groupId}/events/{eventId}**

Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access.

This resource remains under revision and may change.

[Return Events from One Project](https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents)

## 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.
- **eventId** (string)
  Unique 24-hexadecimal digit string that identifies the event that you want to return.

### 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.
- **includeRaw** (boolean)
  Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.


## Responses
### 200
OK

#### Body: application/vnd.atlas.2023-01-01+json (object)
- **apiKeyId** (string)
  Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.
- **created** (string(date-time))
  Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- **eventTypeName** (string)
  Unique identifier of event type.
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.
- **id** (string)
  Unique 24-hexadecimal digit string that identifies the event.
- **isGlobalAdmin** (boolean)
  Flag that indicates whether a MongoDB employee triggered the specified event.
- **links** (array[object])
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
- **orgId** (string)
  Unique 24-hexadecimal digit string that identifies the organization to which these events apply.
- **publicKey** (string)
  Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.
- **raw** (object)
  Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.
- **remoteAddress** (string)
  IPv4 or IPv6 address from which the user triggered this event.
- **userId** (string)
  Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.
- **username** (string(email))
  Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.

### 401
Unauthorized.

#### Body: 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: 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: 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: 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)