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.

  Default value is false.

• pretty boolean

  Flag that indicates whether the response body should be in the prettyprint format.

  Default value is false.

  Prettyprint

Responses

• 200 application/vnd.atlas.2023-01-01+json

  OK

  Hide response attributes Show response attributes object

  • apiKey object | null Required

    Details contained in one API key.

    Hide apiKey attributes Show apiKey attributes object | null

    • accessList array[object]

      List of network addresses granted access to this API using this API key.

      Hide accessList attributes Show accessList attributes object

      • cidrBlock string

        Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.

        Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.

      • ipAddress string Required

        IP address included in the API access list.

        Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

    • id string Required

      Unique 24-hexadecimal digit string that identifies this organization API key.

      Format should match the following pattern: ^([a-f0-9]{24})$.

    • publicKey string Required

      Public API key value set for the specified organization API key.

      Minimum length is 8, maximum length is 8.

    • roles array[object]

      List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.

      MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.

      Hide roles attributes Show roles attributes object

      • groupId string

        Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.

        Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

      • orgId string

        Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request.

        Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

      • roleName string

        Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.

        Values are ORG_MEMBER, ORG_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_GROUP_CREATOR, ORG_OWNER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_CLUSTER_MANAGER, GROUP_SEARCH_INDEX_EDITOR, GROUP_STREAM_PROCESSING_OWNER, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

  • appName string Required

    Human-readable label that identifies the service from which you requested this response.

    Value is MongoDB Atlas.

  • build string Required

    Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.

  • 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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • throttling boolean Required

    Flag that indicates whether someone enabled throttling on this service.

• 401

  Unauthorized.

• 403 application/json

  Forbidden.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

        A path that leads to a field in the request body.

  • detail string

    Describes the specific conditions or reasons that cause each type of error.

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    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 application/json

  Internal Server Error.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

        A path that leads to a field in the request body.

  • detail string

    Describes the specific conditions or reasons that cause each type of error.

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    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.