MongoDB Atlas App Services Admin API (3.0)

Download OpenAPI specification:Download

App Services 관리자 API를 사용하면 HTTPS를 통해 프로그래밍 방식으로 관리 작업을 수행할 수 있습니다. 여기에는 정의 및 구성 등의 작업이 포함됩니다.

  • 앱 배포 & 보안
  • API & 엔드포인트
  • 인증 & 사용자 관리
  • 데이터 소스
  • Device Sync
  • 환경
  • 함수
  • 로그
  • 규칙
  • Schemas
  • 정적 호스팅
  • 트리거
  • 사용량 & 청구 지표
  • Values & Secrets

관리자 API는 애플리케이션 개발, 구성 및 배포를 위한 것입니다. 관리자 API로 구성한 기능을 실제로 사용하려면 클라이언트 애플리케이션을 Atlas Device SDK 또는 앱 전용 HTTPS API를 통해 연결해야 합니다.

Project & Application IDs

참고: 프로젝트 ID그룹 ID라는 용어는 서로 바꿔 사용할 수 있습니다.

Atlas App Services 관리자 API 엔드포인트의 경우 URL에 두 개의 매개변수를 포함해야 하는 경우가 많습니다.

  • Atlas 프로젝트 ID(그룹 ID라고도 함)
  • App Services 애플리케이션 ID

프로젝트 ID

프로젝트 ID는 MongoDB Atlas 대시보드 또는 MongoDB Atlas CLI에서 찾을 수 있습니다.

애플리케이션 ID

애플리케이션 ID를 찾으려면 프로젝트의 앱 나열 엔드포인트에 요청합니다. 이 요청을 하려면 access_token이 필요합니다. 토큰 획득 방법을 알아보려면 관리자 API 세션 액세스 토큰 가져오기를 참조하세요.

curl --request GET \
  --header 'Authorization: Bearer <access_token>' \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps

그러면 제공된 프로젝트/그룹의 각 App Services 앱을 설명하는 객체 목록이 반환됩니다. 관리자 API 요청의 경우 애플리케이션 ID는 client_app_id아니라 _id 필드의 ObjectId 값입니다.

[
  {
    "_id": "5997529e46224c6e42gb6dd9",
    "group_id": "57879f6cc4b32dbe440bb8c5",
    "domain_id": "5886619e46124e4c42fb5dd8",
    "client_app_id": "myapp-abcde",
    "name": "myapp",
    "location": "US-VA",
    "deployment_model": "GLOBAL",
    "last_used": 1615153544,
    "last_modified": 0,
    "product": "standard",
    "environment": ""
  }
]

Get an Admin API Session Access Token

App Services 관리자 API에 대한 모든 요청에는 MongoDB 클라우드 API에서 발급한 유효하고 만료되지 않은 액세스 토큰이 포함되어야 합니다. 베어러 인증 체계를 사용하여 각 요청의 Authorization 헤더에 이 토큰을 포함합니다.

토큰을 가져오려면 MongoDB Atlas에 유효한 MongoDB Atlas 프로그래밍 방식 API 키가 필요합니다.

API 키 쌍이 준비되면 인증 엔드포인트를 호출합니다.

curl --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"username": "<Public API Key>", "apiKey": "<Private API Key>"}' \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login

인증이 성공하면 App Services는 JSON 응답 문서의 일부로 액세스 토큰을 반환합니다.

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

access_token은 관리자 API와 상호 작용할 수 있는 한시적 권한을 나타냅니다. 요청을 인증하려면 베어러 토큰 Authorization 헤더에 토큰을 포함합니다.

Authorization: Bearer <access_token>

Refresh an Admin API Session Access Token

세션 액세스 토큰은 발급된 후 30분 후에 만료됩니다. 로그인하면 응답에 새 액세스 토큰을 얻는 데 사용할 수 있는 refresh_token도 포함됩니다. 자격 증명을 사용하여 한 번만 로그인하면 되기 때문에 유용합니다. 그 후에는 새로 고침 토큰을 사용하여 토큰이 유효한 기간 동안 재인증할 수 있습니다.

기본적으로 새로 고침 토큰은 발행 후 60일 후에 만료됩니다. 새로 고침 토큰 만료를 최소 30분 또는 최대 5년으로 사용자 지정할 수 있습니다.

인증을 새로 고치고 새 access_token을 가져오려면 Authorization 헤더에 refresh_token을 사용하여 인증 세션 엔드포인트를 호출합니다.

curl --request POST \
  --header 'Authorization: Bearer <refresh_token>' \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/session

새로 고침 토큰이 유효한 경우 응답 본문에는 다음 30분 동안 유효한 새 access_token이 포함됩니다.

{
  "access_token": "<access_token>"
}

Administrator

로그인하여 App Services 앱을 관리합니다.

List App Services Admin Auth Providers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Authenticate as an App Services administrator

Atlas 프로그래밍 방식 API 키 쌍을 사용하여 App Services 관리자로 인증합니다. 자세한 내용은 관리자 API 세션 액세스 토큰 가져오기를 참조하세요.

Request Body schema: application/json
username
required
string
apiKey
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "apiKey": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "user_id": "string",
  • "device_id": "string"
}

Get information about the currently logged in user

Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "domain_id": "string",
  • "identities": [
    ],
  • "data": {
    },
  • "type": "normal",
  • "roles": [
    ]
}

Obtain a session access token

Authorizations:
refreshAuth

Responses

Response samples

Content type
application/json
{
  • "access_token": "string"
}

Delete a session access token

Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
{
  • "error": "invalid session: failed to find refresh token",
  • "error_code": "InvalidSession"
}

API Keys

API 키 제공자를 통해 API 키를 보고 관리합니다.

List API keys

Atlas App Services 앱과 연결된 API 키를 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new API key

API 키를 생성합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

생성할 API 키입니다.

name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "key": "string",
  • "name": "string",
  • "disabled": "string"
}

Retrieve information about an API key

API 키에 대한 정보를 조회합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

apiKeyId
required
string

API 키의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": "string"
}

Delete an API key

API 키를 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

apiKeyId
required
string

API 키의 고유한 _id 값입니다.

Responses

Enable an API key

API 키를 활성화합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

apiKeyId
required
string

API 키의 고유한 _id 값입니다.

Responses

Disable an API key

API 키를 비활성화합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

apiKeyId
required
string

API 키의 고유한 _id 값입니다.

Responses

Applications

Atlas 프로젝트에서 애플리케이션을 보고 관리합니다.

List all App Services Apps in an Atlas project/group

Atlas 프로젝트/그룹 내의 모든 App Services 앱을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

query Parameters
product
string
Enum: "standard" "atlas" "data-api" "device-sync"

하나 이상의 특정 App Services 제품 유형입니다. 지정된 경우 이 엔드포인트는 지정된 제품 유형의 앱만 반환합니다.

대부분의 앱은 이 엔드포인트가 기본적으로 반환하는 standard 제품 유형을 사용합니다. atlas, data-apidevice-sync 제품 유형은 Atlas UI를 통해 액세스할 수 있는 Atlas 트리거, Atlas 데이터 APIAtlas Device Sync를 위한 특수 앱을 나타냅니다.

여러 제품 유형을 쉼표로 구분된 목록으로 지정할 수 있습니다.

/groups/{groupId}/apps?product=atlas,data-api

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new app

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

query Parameters
defaults
boolean

기본 애플리케이션을 만들지 여부입니다.

product
string
Enum: "standard" "atlas" "data-api" "device-sync"

앱의 제품 유형입니다. 앱은 기본적으로 standard 제품 유형을 사용합니다. 대부분의 앱의 경우 product를 전혀 지정할 필요가 없거나 standard를 지정해야 합니다.

atlas, data-apidevice-sync 제품 유형은 Atlas UI를 통해 액세스할 수 있는 Atlas 트리거, Atlas 데이터 APIAtlas Device Sync를 위한 특수 앱을 나타냅니다.

Request Body schema: application/json

생성할 애플리케이션입니다.

name
string

애플리케이션의 이름입니다. 문자로 시작해야 하며 ASCII 문자, 숫자, 밑줄, 하이픈만 포함할 수 있습니다.

AwsDeploymentRegion (string) or AzureDeploymentRegion (string) or GcpDeploymentRegion (string) (CloudProviderRegionId)
location
string (DeploymentLocation)
Enum: "US-VA" "US-OR" "DE-FF" "IE" "AU" "IN-MB" "SG" "BR-SP"

애플리케이션의 실제 배포 위치입니다. 이 값은 보다 구체적인 provider_region 값과 일치해야 합니다. 예를 들어, aws-us-west-2provider_region이 있는 앱은 US-OR location에 매핑됩니다.

deployment_model
string (DeploymentModel)
Enum: "GLOBAL" "LOCAL"

애플리케이션 배포 모델입니다.

environment
string (NullableAppEnvironment)
Enum: "development" "testing" "qa" "production" ""

애플리케이션의 환경입니다. 빈 문자열은 앱에 지정된 환경이 없음을 나타냅니다.

template_id
string

새 앱의 기반으로 사용할 App Services 템플릿 앱의 ID입니다.

AtlasCluster (object) or AtlasFederatedInstance (object) (DataSource)

Responses

Request samples

Content type
application/json
{
  • "name": "MyApp",
  • "provider_region": "aws-us-east-1",
  • "location": "US-VA",
  • "deployment_model": "GLOBAL",
  • "environment": "production",
  • "template_id": "string",
  • "data_source": {
    }
}

Response samples

Content type
application/json
{
  • "name": "MyApp",
  • "provider_region": "aws-us-east-1",
  • "location": "US-VA",
  • "deployment_model": "GLOBAL",
  • "environment": "production",
  • "_id": "633209ffd3bd3478005d1bac",
  • "client_app_id": "myapp-abcde",
  • "domain_id": "63320a2b5f9de9a6e0a213e8",
  • "group_id": "5b2ec991973129243223a114",
  • "last_used": 1664224746,
  • "last_modified": 1656440824,
  • "product": "standard"
}

Get an app

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "name": "MyApp",
  • "provider_region": "aws-us-east-1",
  • "location": "US-VA",
  • "deployment_model": "GLOBAL",
  • "environment": "production",
  • "_id": "633209ffd3bd3478005d1bac",
  • "client_app_id": "myapp-abcde",
  • "domain_id": "63320a2b5f9de9a6e0a213e8",
  • "group_id": "5b2ec991973129243223a114",
  • "last_used": 1664224746,
  • "last_modified": 1656440824,
  • "product": "standard"
}

Delete an app

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Export an app as a zip file

내보내기 엔드포인트는 더 이상 사용되지 않습니다. 대신 Accept: application/zip 헤더를 사용하여 앱 구성 파일 가져오기 엔드포인트를 호출합니다.

애플리케이션을 zip 파일로 내보냅니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
deployment
string
Example: deployment=6373362f01a569d5cd571c68

내보낼 특정 배포의 _id입니다. 지정하지 않은 경우 최신 배포를 내보냅니다.

source_control
boolean
Default: false

true인 경우 내보낸 디렉토리는 GitHub 또는 기타 소스 제어의 자동 배포에 적합합니다.

template 쿼리 매개변수와 함께 사용할 수 없습니다.

template
boolean
Default: false

true인 경우 내보낸 디렉토리에는 앱을 특정 배포 인스턴스에 연결하는 식별자 또는 기타 데이터가 포함되지 않습니다.

source_control 쿼리 매개변수와 함께 사용할 수 없습니다.

version
string
Example: version=20210101

내보낼 구성 파일 스키마 버전입니다. 이 값은 root_config.json에서 config_version에 해당합니다.

Responses

Pull App Configuration Files

현재 앱 구성을 다운로드합니다. 두 가지 형식으로 다운로드하도록 선택할 수 있습니다.

  • 구성 파일 디렉토리가 포함된 압축된 zip 파일입니다. 이는 CLI, 버전 제어 시스템 또는 파일 시스템 기반의 다른 환경으로 작업할 때 가장 유용합니다.

  • 전체 구성을 포함하는 단일 JSON 객체입니다. 이는 API 또는 JSON을 구문 분석할 수 있는 다른 환경으로 작업할 때 가장 유용합니다.

Accept 헤더를 설정하여 다운로드할 형식을 지정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
{
  • "name": "string",
  • "provider_region": "aws-us-east-1",
  • "deployment_model": "GLOBAL",
  • "environment": "production",
  • "auth_providers": [
    ],
  • "custom_user_data": {
    },
  • "data_api_config": {
    },
  • "data_sources": [
    ],
  • "endpoints": [
    ],
  • "environments": {
    },
  • "functions": [
    ],
  • "graphql": {
    },
  • "hosting": {
    },
  • "https_endpoints": [
    ],
  • "log_forwarders": [
    ],
  • "schemas": [
    ],
  • "services": [
    ],
  • "sync": {
    },
  • "triggers": [
    ],
  • "values": [
    ]
}

Push App Configuration Files

새로운 전체 앱 구성을 업로드합니다. 이 작업은 기존 앱 구성 전체를 덮어씁니다.

참고: 앱 구성에 시크릿에 대한 참조가 포함되어 있는 경우 구성을 푸시하기 전에 시크릿을 생성해야 합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
name
required
string

앱의 이름입니다.

required
AwsDeploymentRegion (string) or AzureDeploymentRegion (string) or GcpDeploymentRegion (string) (CloudProviderRegionId)
deployment_model
required
string (DeploymentModel)
Enum: "GLOBAL" "LOCAL"

애플리케이션 배포 모델입니다.

environment
string (AppEnvironment)
Enum: "development" "testing" "qa" "production"

앱의 환경 태그입니다. 지정하지 않으면 앱에 환경 태그가 없습니다.

required
Array of AnonymousAuthProvider (object) or EmailPasswordAuthProvider (object) or ApiKeyAuthProvider (object) or CustomJwtAuthProvider (object) or CustomFunctionAuthProvider (object) or AppleAuthProvider (object) or GoogleAuthProvider (object) or FacebookAuthProvider (object) (AuthProviderConstructor)
CustomUserDataConstructor (object) or null
DataApiConfig (object) or null
required
Array of AtlasClusterConstructor (object) or AtlasFederatedInstanceConstructor (object) (DataSourceConstructor)
required
Array of objects (EndpointConstructor)
required
object (AllEnvironmentValues)
required
Array of objects (FunctionConstructor)
required
object (GraphQLConstructor)
required
object (HostingConstructor)
required
Array of objects (ThirdPartyServiceConstructor)

[더 이상 사용되지 않음] 레거시 HTTP 서비스 목록입니다. 이는 이전 버전과의 호환성을 위한 용도로만 사용됩니다.

required
Array of objects (LogForwarderConstructor)
required
Array of objects (FullSchema)
required
Array of objects (ThirdPartyServiceConstructor)

[더 이상 사용되지 않음] 레거시 타사 비 HTTP 서비스 목록입니다. 이는 이전 버전과의 호환성을 위한 용도로만 사용됩니다.

required
object (FlexibleSync)
required
Array of DatabaseTrigger (object) or AuthenticationTrigger (object) or ScheduledTrigger (object) (TriggerConstructor)
required
Array of objects (ValueConstructor)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "provider_region": "aws-us-east-1",
  • "deployment_model": "GLOBAL",
  • "environment": "production",
  • "auth_providers": [
    ],
  • "custom_user_data": {
    },
  • "data_api_config": {
    },
  • "data_sources": [
    ],
  • "endpoints": [
    ],
  • "environments": {
    },
  • "functions": [
    ],
  • "graphql": {
    },
  • "hosting": {
    },
  • "https_endpoints": [
    ],
  • "log_forwarders": [
    ],
  • "schemas": [
    ],
  • "services": [
    ],
  • "sync": {
    },
  • "triggers": [
    ],
  • "values": [
    ]
}

Authentication Providers

인증 제공자를 보고 관리합니다.

List authentication providers in a Atlas App Services App

Atlas App Services 앱 내에서 인증 제공자를 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an authentication provider

인증 제공자를 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
Any of
name
required
string

인증 제공자의 이름입니다. 이 값은 type의 값과 같아야 합니다.

Value: "anon-user"
type
required
string
Enum: "anon-user" "local-userpass" "api-key" "oauth2-apple" "oauth2-google" "oauth2-facebook" "custom-token" "custom-function"

인증 제공자의 이름입니다. 익명 인증의 경우 이 값은 항상 anon-user입니다.

Value: "anon-user"
disabled
boolean

true인 경우 인증 제공자가 비활성화됩니다. 활성화될 때까지 사용자는 제공자를 통해 로그인할 수 없습니다.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "anon-user",
  • "type": "anon-user",
  • "disabled": true
}

Response samples

Content type
application/json
Example
{
  • "name": "anon-user",
  • "type": "anon-user",
  • "disabled": true,
  • "_id": "string"
}

Retrieve information about authentication provider

애플리케이션의 인증 제공자 중 하나에 대한 정보를 조회합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

providerId
required
string

인증 제공자의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
Example
{
  • "name": "anon-user",
  • "type": "anon-user",
  • "disabled": true,
  • "_id": "string"
}

Delete an authentication provider

인증 제공자를 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

providerId
required
string

인증 제공자의 고유한 _id 값입니다.

Responses

Update an authentication provider

인증 제공자를 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

providerId
required
string

인증 제공자의 고유한 _id 값입니다.

Request Body schema: application/json
Any of
name
required
string

인증 제공자의 이름입니다. 이 값은 type의 값과 같아야 합니다.

Value: "anon-user"
type
required
string
Enum: "anon-user" "local-userpass" "api-key" "oauth2-apple" "oauth2-google" "oauth2-facebook" "custom-token" "custom-function"

인증 제공자의 이름입니다. 익명 인증의 경우 이 값은 항상 anon-user입니다.

Value: "anon-user"
disabled
boolean

true인 경우 인증 제공자가 비활성화됩니다. 활성화될 때까지 사용자는 제공자를 통해 로그인할 수 없습니다.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "anon-user",
  • "type": "anon-user",
  • "disabled": true
}

Disable an authentication provider

인증 제공자를 비활성화합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

providerId
required
string

인증 제공자의 고유한 _id 값입니다.

Responses

Enable an authentication provider

인증 제공자를 활성화합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

providerId
required
string

인증 제공자의 고유한 _id 값입니다.

Responses

Billing

애플리케이션의 청구된 사용량을 확인합니다.

List group billing usage in a given period

청구 목적에 대해 특정 기간 동안 요청, 계산, 동기화 및 데이터 전송 사용량을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

query Parameters
start
string

쿼리 기간이 시작되는 ISO 8601 날짜 및 시간입니다. 기본값은 현재 달의 1일 00:00:00 UTC입니다.

end
string

쿼리 기간이 종료되는 ISO 8601 날짜 및 시간입니다. 기본값은 현재 월 마지막 날의 23:59:59 UTC입니다.

granularity
string
Enum: "P31D" "PT1H"

쿼리 기간의 세분성을 P31D(31일) 또는 PT1H(1시간)로 지정합니다. 기본값은 P31D입니다.

Responses

Response samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "granularity": "string",
  • "group_id": "string",
  • "measurements": [
    ]
}

List app billing usage

청구 목적에 대해 특정 기간 동안 특정 앱의 요청, 계산, 동기화, 데이터 전송 및 메모리 사용량을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
start
string

쿼리 기간이 시작되는 ISO 8601 날짜 및 시간입니다. 기본값은 현재 달의 1일 00:00:00 UTC입니다.

end
string

쿼리 기간이 종료되는 ISO 8601 날짜 및 시간입니다. 기본값은 현재 월 마지막 날의 23:59:59 UTC입니다.

granularity
string
Enum: "P31D" "PT1H"

쿼리 기간의 세분성을 P31D(31일) 또는 PT1H(1시간)로 지정합니다. 기본값은 P31D입니다.

Responses

Response samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "granularity": "string",
  • "group_id": "string",
  • "appId": "string",
  • "appName": "string",
  • "measurements": [
    ]
}

Custom User Data

Get the Custom User Data Configuration

Atlas App Services 앱에 대한 사용자 지정 사용자 데이터 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "database_name": "myapp",
  • "collection_name": "users",
  • "user_id_field": "user_account_id",
  • "enabled": true,
  • "mongo_service_id": "63c060ed32043ef4c93c2a9c",
  • "on_user_creation_function_id": "63c055d8019a6ab879f661d6"
}

Configure Custom User Data

Atlas App Services 앱에 대한 사용자 지정 사용자 데이터 구성을 수정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
database_name
string

사용자 지정 사용자 데이터가 포함된 데이터베이스의 이름입니다.

collection_name
string

사용자 지정 사용자 데이터가 포함된 컬렉션의 이름입니다.

user_id_field
string

모든 사용자 지정 사용자 데이터 문서에 표시되고 각 문서에 해당하는 사용자의 사용자 계정 ID를 포함하는 필드의 이름입니다.

enabled
boolean

true인 경우 사용자 지정 사용자 데이터가 활성화됩니다.

mongo_service_id
string

연결된 MongoDB 데이터 소스 의 _id 값입니다.

모든 서비스 가져오기 엔드포인트 를 사용하여 서비스를 나열할 수 있습니다.

데이터 소스는 type 이 'mongodb-atlas'인 서비스입니다. 트리거에 연결하려는 데이터 소스 에 대해 _id 값을 사용합니다.

on_user_creation_function_id
string

새 사용자가 등록할 때마다 실행되는 사용자 생성 함수_id 값입니다.

Responses

Request samples

Content type
application/json
{
  • "database_name": "myapp",
  • "collection_name": "users",
  • "user_id_field": "user_account_id",
  • "enabled": true,
  • "mongo_service_id": "63c060ed32043ef4c93c2a9c",
  • "on_user_creation_function_id": "63c055d8019a6ab879f661d6"
}

Deployment

Draft and Deploy a Group of Changes

초안을 만들고 배포하여 애플리케이션 변경 사항 그룹을 함께 배포할 수 있습니다. 일련의 초안 변경 사항을 생성하고 배포하려면 다음을 수행합니다.

1. 새 초안 만들기

초안은 단일 단위로 배포하거나 삭제할 수 있는 애플리케이션 변경 사항 그룹을 나타냅니다. 초안을 만들려면 초안 엔드포인트에 POST 요청을 보냅니다.

curl --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <access_token>' \
  'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts'

사용자당 1개 초안

각 사용자는 UI나 관리자 API를 통해 한 번에 1개 초안만 만들 수 있습니다. 기존 초안이 이미 있는 경우 초안의 엔드포인트에 DELETE 요청을 전송하여 기존 초안과 관련된 변경 사항을 삭제할 수 있습니다.

curl --request DELETE \
  --header 'Authorization: Bearer <access_token>' \
  'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts/{draftId}'

2. 애플리케이션 변경

초안을 만든 후에는 초안에 포함할 내용을 변경 사항을 모두 적용합니다. App Services는 함께 배포할 수 있도록 초안에 대한 모든 애플리케이션 변경 사항을 추가합니다.

3. 초안 배포

배포에 포함하려는 변경 사항을 모두 적용한 후 해당 초안의 배포 엔드포인트에 POST 요청을 전송하여 초안을 배포합니다.

curl --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <access_token>' \
  'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts/{draftId}/deployment'

초안 충돌

API를 통해 변경 사항을 배포했는데 UI의 초안에서 변경 사항이 충돌하는 경우 UI 초안이 유효하지 않게 되어 배포할 수 없게 됩니다. Deployment 페이지에서 초안을 검토하여 UI 초안을 다운로드할 수 있습니다. 다운로드를 사용하여 appservices CLI에서 변경 사항을 배포하거나 UI에서 변경 사항을 다시 적용할 때 참조로 사용할 수 있습니다.

List all available Atlas App cloud regions

Atlas 앱을 배포할 수 있는 지원되는 모든 클라우드 리전 목록을 반환합니다.

Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the Deployment Configuration

앱이 변경 사항을 배포하는 방법에 대한 정보를 참조하세요.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "ui_drafts_disabled": true,
  • "automatic_deployment": {
    },
  • "last_modified": 0
}

Configure Deployment

앱의 배포 구성을 수정하여 앱이 변경 사항을 배포하는 방식을 사용자 지정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
ui_drafts_disabled
required
boolean

true인 경우 저장 시 관리자 UI의 모든 변경 사항이 자동으로 배포됩니다. false인 경우 변경 사항이 배포 초안으로 그룹화되어 별도로 배포됩니다.

required
object

자동 배포 메서드 구성

last_modified
number

이 구성이 마지막으로 수정된 시간은 유닉스 시간 이후의 시간(초)으로 표시됩니다.

Responses

Request samples

Content type
application/json
{
  • "ui_drafts_disabled": true,
  • "automatic_deployment": {
    },
  • "last_modified": 0
}

List recent deployments

가장 최근에 배포된 애플리케이션 25개를 반환합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a deployment

애플리케이션의 최근 배포에 대한 정보를 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

deploymentId
required
string

애플리케이션 배포의 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "app_id": "string",
  • "draft_id": "string",
  • "user_id": "string",
  • "deployed_at": 0,
  • "origin": "string",
  • "commit": "string",
  • "status": "string",
  • "status_error_message": "string",
  • "diff_url": "string",
  • "remote_location": "US-VA"
}

Redeploy a Deployment

이전에 배포한 버전의 앱을 다시 배포합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

deploymentId
required
string

애플리케이션 배포의 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "error": "deployment not found",
  • "error_code": "DeploymentNotFound"
}

Get Current Deployment Draft

해당되는 경우 현재 애플리케이션 배포 초안을 반환합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "user_id": "string",
  • "app": {
    }
}

Create a Deployment Draft

애플리케이션 배포 초안이 없는 경우 새 애플리케이션 배포 초안을 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "user_id": "string",
  • "app": {
    }
}

Discard the specified deployment draft

지정된 애플리케이션 배포 초안을 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

draftId
required
string

초안의 고유한 _id 값입니다.

Responses

Deploy a deployment draft

지정된 애플리케이션 배포 초안을 배포합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

draftId
required
string

초안의 고유한 _id 값입니다.

Request Body schema: application/json
name
required
string

배포의 이름입니다. 이름 없이 초안을 배포하려면 빈 문자열을 사용합니다.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "app_id": "string",
  • "draft_id": "string",
  • "user_id": "string",
  • "deployed_at": 0,
  • "origin": "string",
  • "commit": "string",
  • "status": "string",
  • "status_error_message": "string",
  • "diff_url": "string",
  • "remote_location": "US-VA"
}

Diff a draft with the current deployment

현재 배포된 애플리케이션과 지정된 초안 간의 차이점을 반환합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

draftId
required
string

초안의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "diffs": [
    ],
  • "hosting_files_diff": {
    }
}

Get a Deployment Migration

현재 배포 마이그레이션에 대한 메타데이터와 상태를 가져옵니다(있는 경우).

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "status": "started",
  • "message": "string",
  • "updated_at": "string",
  • "from": {
    },
  • "to": {
    }
}

Create a Deployment Migration

새 배포 마이그레이션을 시작합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

앱이 마이그레이션해야 하는 배포 모델 및 클라우드 공급자 리전

deployment_model
string (DeploymentModel)
Enum: "GLOBAL" "LOCAL"

애플리케이션 배포 모델입니다.

AwsDeploymentRegion (string) or AzureDeploymentRegion (string) or GcpDeploymentRegion (string) (CloudProviderRegionId)

Responses

Request samples

Content type
application/json
{
  • "deployment_model": "LOCAL",
  • "provider_region": "aws-us-east-1"
}

Data API

앱에서 생성된 데이터 API 엔드포인트를 관리합니다.

Construct a Data API Base URL

데이터 API 요청은 앱 및 배포 모델에 고유한 기본 URL을 사용합니다.

글로벌로 배포된 앱의 경우 기본 URL의 형식은 다음과 같습니다.

https://data.mongodb-api.com/app/{ClientAppID}/endpoint/data/{DataAPIVersion}

로컬로 배포된 앱은 유사한 기본 URL을 사용하며 앱의 배포 리전과 클라우드 공급자도 포함합니다.

https://{Region}.{Cloud}.data.mongodb-api.com/app/{ClientAppID}/endpoint/data/{DataAPIVersion}

앱 구성에서 앱의 Region, CloudClientAppId를 찾을 수 있습니다.

curl -X GET https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId} \
  -h 'Authorization: Bearer <AccessToken>'

데이터 API 구성versions 필드에서 앱에서 지원하는 모든 DataAPIVersion 값 목록을 볼 수 있습니다.

curl -X GET "https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/data_api/config" \
  -h 'Authorization: Bearer <AccessToken>'

예를 들어 다음과 같은 구성이 있는 앱을 가정해 보겠습니다.

{
  "client_app_id": "myapp-abcde",
  "deployment_model": "LOCAL",
  "provider_region": "aws-us-east-1",
  ...
}

이 앱은 데이터 API v1 요청에 대해 다음 기본 URL을 사용합니다.

https://us-east-1.aws.data.mongodb-api.com/app/myapp-abcde/endpoint/data/v1

Get the Data API Configuration

앱의 데이터 API 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "disabled": true,
  • "versions": [
    ],
  • "return_type": "JSON",
  • "create_user_on_auth": true,
  • "run_as_user_id": "string",
  • "run_as_user_id_script_source": "string",
  • "validation_method": "NO_VALIDATION",
  • "secret_name": "string",
  • "can_evaluate": { }
}

Enable the Data API

앱의 데이터 API 구성을 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

엔드포인트에 대한 유효한 구성 객체입니다.

disabled
required
boolean
versions
required
Array of strings (DataApiVersion)
Items Value: "v1"
return_type
required
string (EndpointDataFormat)
Enum: "JSON" "EJSON"

데이터 API 엔드포인트가 반환하는 기본 데이터 형식입니다.

create_user_on_auth
boolean
run_as_user_id
string

애플리케이션 사용자의 계정 ID. 정의된 경우 엔드포인트는 항상 지정된 사용자로 실행됩니다.

run_as_user_id_script_source
string

애플리케이션 사용자의 계정 ID를 반환하는 함수에 대한 문자열화된 소스 코드입니다. 정의된 경우 엔드포인트는 모든 요청에서 함수를 실행하고 함수에서 반환된 ID를 가진 사용자로 실행됩니다.

validation_method
required
string
Enum: "NO_VALIDATION" "SECRET_AS_QUERY_PARAM" "VERIFY_PAYLOAD"
secret_name
string

validation_method"SECRET_AS_QUERY_PARAM" 또는 "VERIFY_PAYLOAD"로 설정된 경우 요청을 승인하는 시크릿name 니다.

can_evaluate
object

수신 요청에 대한 응답으로 엔드포인트의 실행이 허용되는 경우 true로 평가되는 JSON 표현식입니다.

Responses

Request samples

Content type
application/json
{
  • "disabled": true,
  • "versions": [
    ],
  • "return_type": "JSON",
  • "create_user_on_auth": true,
  • "run_as_user_id": "string",
  • "run_as_user_id_script_source": "string",
  • "validation_method": "NO_VALIDATION",
  • "secret_name": "string",
  • "can_evaluate": { }
}

Response samples

Content type
application/json
{
  • "disabled": true,
  • "versions": [
    ],
  • "return_type": "JSON",
  • "create_user_on_auth": true,
  • "run_as_user_id": "string",
  • "run_as_user_id_script_source": "string",
  • "validation_method": "NO_VALIDATION",
  • "secret_name": "string",
  • "can_evaluate": { }
}

Modify the Data API

앱의 데이터 API 구성을 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

엔드포인트에 대한 유효한 구성 객체입니다.

disabled
required
boolean
versions
required
Array of strings (DataApiVersion)
Items Value: "v1"
return_type
required
string (EndpointDataFormat)
Enum: "JSON" "EJSON"

데이터 API 엔드포인트가 반환하는 기본 데이터 형식입니다.

create_user_on_auth
boolean
run_as_user_id
string

애플리케이션 사용자의 계정 ID. 정의된 경우 엔드포인트는 항상 지정된 사용자로 실행됩니다.

run_as_user_id_script_source
string

애플리케이션 사용자의 계정 ID를 반환하는 함수에 대한 문자열화된 소스 코드입니다. 정의된 경우 엔드포인트는 모든 요청에서 함수를 실행하고 함수에서 반환된 ID를 가진 사용자로 실행됩니다.

validation_method
required
string
Enum: "NO_VALIDATION" "SECRET_AS_QUERY_PARAM" "VERIFY_PAYLOAD"
secret_name
string

validation_method"SECRET_AS_QUERY_PARAM" 또는 "VERIFY_PAYLOAD"로 설정된 경우 요청을 승인하는 시크릿name 니다.

can_evaluate
object

수신 요청에 대한 응답으로 엔드포인트의 실행이 허용되는 경우 true로 평가되는 JSON 표현식입니다.

Responses

Request samples

Content type
application/json
{
  • "disabled": true,
  • "versions": [
    ],
  • "return_type": "JSON",
  • "create_user_on_auth": true,
  • "run_as_user_id": "string",
  • "run_as_user_id_script_source": "string",
  • "validation_method": "NO_VALIDATION",
  • "secret_name": "string",
  • "can_evaluate": { }
}

List Data API versions

가능한 모든 데이터 API 버전을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • "v1"
]

Dependencies

애플리케이션의 외부 종속성을 관리합니다.

List external dependencies

Atlas App Services 앱에 업로드된 외부 종속성을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "location": "string",
  • "user_id": "string",
  • "last_modified": 0,
  • "dependencies_list": [
    ]
}

Endpoints

앱의 사용자 지정 HTTPS 엔드포인트를 보고 관리합니다.

Construct a Custom HTTPS Endpoint Base URL

HTTPS 엔드포인트 요청은 앱 및 배포 모델과 관련된 기본 URL을 사용합니다.

글로벌로 배포된 앱의 경우 기본 URL의 형식은 다음과 같습니다.

https://data.mongodb-api.com/app/{ClientAppID}/endpoint

로컬로 배포된 앱은 유사한 기본 URL을 사용하며 앱의 배포 리전과 클라우드 공급자도 포함합니다.

https://{Region}.{Cloud}.data.mongodb-api.com/app/{ClientAppID}/endpoint

앱 가져오기 엔드포인트를 호출하여 앱의 Region, CloudClientAppId를 찾을 수 있습니다.

curl -X GET https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId} \
  -h 'Authorization: Bearer <AccessToken>'

예를 들어 다음과 같은 구성이 있는 앱을 가정해 보겠습니다.

{
  "client_app_id": "myapp-abcde",
  "deployment_model": "LOCAL",
  "provider_region": "aws-us-east-1",
  ...
}

이 앱은 수신되는 사용자 지정 HTTPS 엔드포인트 요청에 대해 다음 기본 URL을 사용합니다.

https://us-east-1.aws.data.mongodb-api.com/app/myapp-abcde/endpoint

Get all endpoints

모든 엔드포인트 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an endpoint

엔드포인트를 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

새 엔드포인트에 대한 유효한 구성 객체입니다.

route
required
string
http_method
required
string
Enum: "GET" "POST" "PUT" "PATCH" "DELETE" "*"
function_id
required
string

엔드포인트 함수의 고유 ID입니다.

validation_method
required
string
Enum: "NO_VALIDATION" "SECRET_AS_QUERY_PARAM" "VERIFY_PAYLOAD"
secret_id
string

validation_method"SECRET_AS_QUERY_PARAM" 또는 "VERIFY_PAYLOAD"로 설정된 경우 요청을 승인하는 시크릿_id 니다.

return_type
required
string (EndpointDataFormat)
Enum: "JSON" "EJSON"

사용자 지정 HTTPS 엔드포인트가 반환하는 기본 데이터 형식입니다.

respond_result
required
boolean
fetch_custom_user_data
boolean
create_user_on_auth
boolean
disabled
required
boolean
_id
string

엔드포인트의 고유 ID입니다.

Responses

Request samples

Content type
application/json
{
  • "route": "string",
  • "http_method": "GET",
  • "function_id": "string",
  • "validation_method": "NO_VALIDATION",
  • "secret_id": "string",
  • "return_type": "JSON",
  • "respond_result": true,
  • "fetch_custom_user_data": true,
  • "create_user_on_auth": true,
  • "disabled": true,
  • "_id": "string"
}

Response samples

Content type
application/json
{
  • "route": "string",
  • "http_method": "GET",
  • "function_id": "string",
  • "validation_method": "NO_VALIDATION",
  • "secret_id": "string",
  • "return_type": "JSON",
  • "respond_result": true,
  • "fetch_custom_user_data": true,
  • "create_user_on_auth": true,
  • "disabled": true,
  • "_id": "string",
  • "function_name": "string"
}

Get an endpoint

특정 엔드포인트의 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

endpointId
required
string

엔드포인트의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "route": "string",
  • "http_method": "GET",
  • "function_id": "string",
  • "validation_method": "NO_VALIDATION",
  • "secret_id": "string",
  • "return_type": "JSON",
  • "respond_result": true,
  • "fetch_custom_user_data": true,
  • "create_user_on_auth": true,
  • "disabled": true,
  • "_id": "string",
  • "function_name": "string"
}

Modify an endpoint

기존 엔드포인트 구성을 수정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

endpointId
required
string

엔드포인트의 고유한 _id 값입니다.

Request Body schema: application/json

엔드포인트에 대해 유효하고 업데이트된 구성 객체입니다.

route
required
string
http_method
required
string
Enum: "GET" "POST" "PUT" "PATCH" "DELETE" "*"
function_id
required
string

엔드포인트 함수의 고유 ID입니다.

validation_method
required
string
Enum: "NO_VALIDATION" "SECRET_AS_QUERY_PARAM" "VERIFY_PAYLOAD"
secret_id
string

validation_method"SECRET_AS_QUERY_PARAM" 또는 "VERIFY_PAYLOAD"로 설정된 경우 요청을 승인하는 시크릿_id 니다.

return_type
required
string (EndpointDataFormat)
Enum: "JSON" "EJSON"

사용자 지정 HTTPS 엔드포인트가 반환하는 기본 데이터 형식입니다.

respond_result
required
boolean
fetch_custom_user_data
boolean
create_user_on_auth
boolean
disabled
required
boolean
_id
string

엔드포인트의 고유 ID입니다.

Responses

Request samples

Content type
application/json
{
  • "route": "string",
  • "http_method": "GET",
  • "function_id": "string",
  • "validation_method": "NO_VALIDATION",
  • "secret_id": "string",
  • "return_type": "JSON",
  • "respond_result": true,
  • "fetch_custom_user_data": true,
  • "create_user_on_auth": true,
  • "disabled": true,
  • "_id": "string"
}

Response samples

Content type
application/json
{
  • "route": "string",
  • "http_method": "GET",
  • "function_id": "string",
  • "validation_method": "NO_VALIDATION",
  • "secret_id": "string",
  • "return_type": "JSON",
  • "respond_result": true,
  • "fetch_custom_user_data": true,
  • "create_user_on_auth": true,
  • "disabled": true,
  • "_id": "string",
  • "function_name": "string"
}

Delete an endpoint

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

endpointId
required
string

엔드포인트의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{ }

Event Subscriptions

앱의 활성 이벤트 구독을 확인합니다. 이는 예를 들어 MongoDB 변경 스트림에서 실시간 이벤트를 모니터링하여 트리거 및 Device Sync와 같은 애플리케이션 서비스를 구동합니다.

List Event Subscriptions

모든 이벤트 구독을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
type
string
Enum: "DATABASE" "AUTHENTICATION" "SCHEDULED" "SYNCTRANSLATOR"

반환할 이벤트 구독 유형입니다.

  • DATABASE: 데이터베이스 트리거 반환
  • AUTHENTICATION: 인증 트리거 반환
  • SCHEDULED: 예정된 트리거 반환
  • SYNCTRANSLATOR: Device Sync 번역기 반환

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an Event Subscription

이벤트 구독에 대한 정보를 반환합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

eventSubscriptionId
required
string

이벤트 구독의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
Example
{
  • "_id": "string",
  • "name": "onNewEmployee",
  • "type": "DATABASE",
  • "function_id": "5eea9ca4ca0e356e2c2a148a",
  • "config": {
    }
}

Get the Latest Event Subscription Execution

가장 최근에 실행된 이벤트 구독에 대한 정보를 반환합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

eventSubscriptionId
required
string

이벤트 구독의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "resource_id": { },
  • "completed_at": { },
  • "cluster_time": { }
}

Environments

앱의 환경 및 환경 값을 보고 관리합니다.

Set the App Environment

앱의 활성 환경 설정

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
environment
string (NullableAppEnvironment)
Enum: "development" "testing" "qa" "production" ""

애플리케이션의 환경입니다. 빈 문자열은 앱에 지정된 환경이 없음을 나타냅니다.

Responses

Request samples

Content type
application/json
{
  • "environment": "production"
}

Response samples

Content type
application/json
{
  • "name": "MyApp",
  • "provider_region": "aws-us-east-1",
  • "location": "US-VA",
  • "deployment_model": "GLOBAL",
  • "environment": "production",
  • "_id": "633209ffd3bd3478005d1bac",
  • "client_app_id": "myapp-abcde",
  • "domain_id": "63320a2b5f9de9a6e0a213e8",
  • "group_id": "5b2ec991973129243223a114",
  • "last_used": 1664224746,
  • "last_modified": 1656440824,
  • "product": "standard"
}

List All Environment Values

앱의 모든 환경 값에 대한 기본 정보를 가져옵니다. 결과에는 환경별 values가 포함되지 않습니다. 특정 환경에 대한 자세한 내용을 보려면 환경 값 가져오기를 호출합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Environment Value

새 환경 값을 정의합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
_id
string

환경 값의 내부 ID

name
string

환경 값 이름

last_modified
number

이 구성이 마지막으로 수정된 시간은 유닉스 시간 이후의 시간(초)으로 표시됩니다.

object

환경 이름을 값에 매핑하는 객체입니다. 환경 값은 현재 활성 환경의 매핑된 값으로 해석됩니다.

현재 활성 환경에 매핑된 값이 없으면 환경 값은 undefined로 해석됩니다.

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "last_modified": 0,
  • "values": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "last_modified": 0
}

Get an Environment Value

특정 환경 값 세부 정보 가져오기

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

environmentValueId
required
string

환경 값의 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "last_modified": 0,
  • "values": {
    }
}

Modify an Environment Value

기존 환경 값 수정

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

environmentValueId
required
string

환경 값의 _id 값입니다.

Request Body schema: application/json
_id
string

환경 값의 내부 ID

name
string

환경 값 이름

last_modified
number

이 구성이 마지막으로 수정된 시간은 유닉스 시간 이후의 시간(초)으로 표시됩니다.

object

환경 이름을 값에 매핑하는 객체입니다. 환경 값은 현재 활성 환경의 매핑된 값으로 해석됩니다.

현재 활성 환경에 매핑된 값이 없으면 환경 값은 undefined로 해석됩니다.

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "last_modified": 0,
  • "values": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "last_modified": 0
}

Delete an Environment Value

기존 환경 값 삭제

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

environmentValueId
required
string

환경 값의 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": "EnvironmentValueNotFound"
}

Functions

앱의 함수를 보고 관리합니다.

Execute a function

테스트를 위한 함수를 실행합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
user_id
required
string

함수를 실행할 사용자입니다. user_id 또는 run_as_system 중 하나가 필요합니다. 둘 다 지정할 수는 없습니다.

run_as_system
required
boolean

시스템 사용자로 실행할지 여부를 결정합니다. run_as_system 또는 user_id 중 하나가 필요합니다. 둘 다 지정할 수는 없습니다.

Request Body schema: application/json

실행할 함수입니다.

service
string

이 함수를 호출할 때 사용할 서비스입니다.

name
required
string

실행하려는 함수의 이름입니다.

arguments
Array of strings

함수에 필요한 모든 인수입니다.

Responses

Request samples

Content type
application/json
{
  • "service": "string",
  • "name": "string",
  • "arguments": [
    ]
}

Response samples

Content type
application/json
{
  • "error": { },
  • "logs": null,
  • "result": { },
  • "stats": {
    }
}

Execute a function's source code for testing

테스트를 위해 함수의 소스 코드를 실행합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
user_id
required
string

함수를 실행할 사용자입니다. user_id 또는 run_as_system 중 하나가 필요합니다. 둘 다 지정할 수는 없습니다.

run_as_system
required
boolean

시스템 사용자로 실행할지 여부를 결정합니다. run_as_system 또는 user_id 중 하나가 필요합니다. 둘 다 지정할 수는 없습니다.

Request Body schema: application/json

실행할 소스입니다.

eval_source
string

함수를 실행하려면 이 JSON 표현식을 true로 평가해야 합니다. 이 필드가 비어 있으면 true로 평가됩니다.

source
required
string

Responses

Request samples

Content type
application/json
{
  • "eval_source": "string",
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "error": { },
  • "logs": null,
  • "result": { },
  • "stats": {
    }
}

List Functions

함수를 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Function

함수를 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

생성할 함수

can_evaluate
object

수신 요청에 대한 응답으로 함수의 실행이 허용되는 경 true로 평가되는 JSON 표현식입니다.

name
required
string

함수의 고유 이름입니다.

private
required
boolean

true인 경우 클라이언트 애플리케이션에서 함수가 숨겨집니다. JSON 표현식 및 수신 웹훅 및 트리거를 포함한 다른 함수에서 비공개 함수를 계속 호출할 수 있습니다.

source
required
string

함수의 문자열화된 소스 코드입니다. 코드는 유효한 ES6여야 합니다.

run_as_system
boolean

true인 경우 함수가 모든 서비스에 대한 규칙을 우회하여 전체 권한으로 실행됩니다.

run_as_user_id
string

애플리케이션 사용자의 계정 ID입니다. 정의된 경우 엔드포인트는 항상 지정된 사용자로 실행됩니다. run_as_user_id_script_source와 함께 사용할 수 없습니다.

run_as_user_id_script_source
string

애플리케이션 사용자의 계정 ID를 반환하는 함수의 문자열화된 소스 코드입니다. 정의된 경우 엔드포인트는 모든 요청에서 함수를 실행하고 함수에서 반환된 ID를 가진 사용자로 실행됩니다. run_as_user_id와 함께 사용할 수 없습니다.

Responses

Request samples

Content type
application/json
{
  • "can_evaluate": { },
  • "name": "string",
  • "private": true,
  • "source": "string",
  • "run_as_system": true,
  • "run_as_user_id": "string",
  • "run_as_user_id_script_source": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string"
}

Retrieve a Function

함수 를 조회합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

functionId
required
string

함수의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "can_evaluate": { },
  • "name": "string",
  • "private": true,
  • "source": "string",
  • "run_as_system": true,
  • "run_as_user_id": "string",
  • "run_as_user_id_script_source": "string"
}

Delete a Function

함수를 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

functionId
required
string

함수의 고유한 _id 값입니다.

Responses

Update a Function

함수를 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

functionId
required
string

함수의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "can_evaluate": { },
  • "name": "string",
  • "private": true,
  • "source": "string",
  • "run_as_system": true,
  • "run_as_user_id": "string",
  • "run_as_user_id_script_source": "string"
}

GraphQL API

GraphQL API 작업을 구성하고 실행합니다.

Run a query or mutation

인증 및 데이터 액세스 규칙을 우회하는 시스템 사용자로 쿼리 또는 변형을 실행합니다. 인트로스펙션 쿼리를 사용하여 스키마를 포함한 API에 대한 메타데이터에 액세스할 수 있습니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
query
required
string

API에 대한 하나 이상의 유효한 GraphQL 작업을 포함하는 문자열화된 .graphql 파일입니다. 둘 이상의 작업이 정의된 경우 operationName에서 실행할 작업을 지정해야 합니다.

variables
string

각 필드 이름이 지정된 작업의 변수에 값을 매핑하는 문자열화된 JSON 객체입니다.

operationName
string

실행할 query에 지정된 GraphQL 작업의 이름입니다.

Responses

Request samples

Content type
application/json
{
  • "query": "query AllTasks { tasks(query: { status: $status }) { _id owner } }",
  • "variables": "{ \"status\": \"complete\" }",
  • "operationName": "AllTasks"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": [
    ]
}

Get GraphQL API Configuration

앱의 GraphQL API 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "use_natural_pluralization": true,
  • "disable_schema_introspection": true
}

Update GraphQL API Configuration

앱의 GraphQL API 구성을 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

유효한 GraphQL API 구성 객체입니다.

use_natural_pluralization
boolean

true인 경우 생성된 스키마 유형 이름은 가능할 때마다 일반적인 영어 복수형을 사용합니다.

false인 경우 또는 자연 복수형을 결정할 수 없는 경우 복수 유형은 끝에 "s"가 추가된 단수 유형 이름을 사용합니다.

앱을 생성한 후에는 이 값을 변경할 수 없습니다. 모든 새 앱의 경우 이 값은 true입니다.

disable_schema_introspection
boolean

true인 경우 GraphQL API는 클라이언트의 인트로스펙션 쿼리를 차단합니다.

Responses

Request samples

Content type
application/json
{
  • "use_natural_pluralization": true,
  • "disable_schema_introspection": true
}

Get all custom resolvers

앱의 GraphQL API에서 모든 사용자 지정 해석기 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a custom resolver

사용자 지정 해석기를 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

유효한 사용자 지정 해석기 구성 객체입니다.

on_type
required
string

해석기의 상위 유형 이름입니다. "Query", "Mutation" 또는 계산된 속성인 경우 생성된 유형의 이름일 수 있습니다.

field_name
required
string

GraphQL 스키마에 표시되는 사용자 지정 해석기 필드의 이름입니다.

string or object

사용자 지정 해석기의 input 매개변수의 유형입니다. 이는 스칼라, 기존에 생성된 유형의 이름 또는 사용자 지정 JSON schema 객체일 수 있습니다. 정의되지 않은 경우 해석기는 입력을 허용하지 않습니다.

input_type_format
string
Enum: "scalar" "scalar-list" "generated" "generated-list" "custom"

사용자 지정 해석기가 사용하는 입력 유형의 종류입니다. 이 값은 input_type의 값과 일치해야 합니다.

  • 스칼라 입력 유형은 "scalar" 또는 "scalar-list"를 사용해야 합니다.
  • 생성된 입력 유형은 "generated" 또는 "generated-list"를 사용해야 합니다.
  • 사용자 지정 입력 유형은 다음을 사용해야 합니다. "custom"

정의되지 않은 경우 해석기는 입력을 허용하지 않습니다.

string or object

사용자 지정 해석기가 반환하는 값의 유형입니다. 이는 스칼라, 기존에 생성된 유형의 이름 또는 사용자 지정 JSON schema 객체일 수 있습니다.

정의되지 않은 경우 해석기는 DefaultPayload 객체를 반환합니다.

type DefaultPayload {
  status: String!
}
payload_type_format
string
Enum: "scalar" "scalar-list" "generated" "generated-list" "custom"

사용자 지정 해석기가 사용하는 페이로드 유형의 종류입니다. 이 값은 payload_type의 값과 일치해야 합니다.

  • 스칼라 페이로드 유형은 "scalar" 또는 "scalar-list"를 사용해야 합니다.
  • 생성된 페이로드 유형은 "generated" 또는 "generated-list"를 사용해야 합니다.
  • 사용자 지정 페이로드 유형은 다음을 사용해야 합니다. "custom"

정의되지 않은 경우 해석기는 DefaultPayload 객체를 반환합니다.

_id
required
string

사용자 지정 해석기의 고유 ID입니다.

function_id
required
string

해석기 함수의 고유 ID입니다.

Responses

Request samples

Content type
application/json
{
  • "on_type": "string",
  • "field_name": "string",
  • "input_type": "string",
  • "input_type_format": "scalar",
  • "payload_type": "string",
  • "payload_type_format": "scalar",
  • "_id": "string",
  • "function_id": "string"
}

Response samples

Content type
application/json
{
  • "on_type": "string",
  • "field_name": "string",
  • "input_type": "string",
  • "input_type_format": "scalar",
  • "payload_type": "string",
  • "payload_type_format": "scalar",
  • "_id": "string",
  • "function_id": "string"
}

Get a custom resolver

특정 사용자 지정 해석기 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

customResolverId
required
string

사용자 지정 해석기의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "on_type": "string",
  • "field_name": "string",
  • "input_type": "string",
  • "input_type_format": "scalar",
  • "payload_type": "string",
  • "payload_type_format": "scalar",
  • "_id": "string",
  • "function_id": "string"
}

Modify a custom resolver

기존 사용자 지정 해석기 구성을 수정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

customResolverId
required
string

사용자 지정 해석기의 고유한 _id 값입니다.

Request Body schema: application/json

유효하고 업데이트된 사용자 지정 해석기 구성 객체입니다.

on_type
required
string

해석기의 상위 유형 이름입니다. "Query", "Mutation" 또는 계산된 속성인 경우 생성된 유형의 이름일 수 있습니다.

field_name
required
string

GraphQL 스키마에 표시되는 사용자 지정 해석기 필드의 이름입니다.

string or object

사용자 지정 해석기의 input 매개변수의 유형입니다. 이는 스칼라, 기존에 생성된 유형의 이름 또는 사용자 지정 JSON schema 객체일 수 있습니다. 정의되지 않은 경우 해석기는 입력을 허용하지 않습니다.

input_type_format
string
Enum: "scalar" "scalar-list" "generated" "generated-list" "custom"

사용자 지정 해석기가 사용하는 입력 유형의 종류입니다. 이 값은 input_type의 값과 일치해야 합니다.

  • 스칼라 입력 유형은 "scalar" 또는 "scalar-list"를 사용해야 합니다.
  • 생성된 입력 유형은 "generated" 또는 "generated-list"를 사용해야 합니다.
  • 사용자 지정 입력 유형은 다음을 사용해야 합니다. "custom"

정의되지 않은 경우 해석기는 입력을 허용하지 않습니다.

string or object

사용자 지정 해석기가 반환하는 값의 유형입니다. 이는 스칼라, 기존에 생성된 유형의 이름 또는 사용자 지정 JSON schema 객체일 수 있습니다.

정의되지 않은 경우 해석기는 DefaultPayload 객체를 반환합니다.

type DefaultPayload {
  status: String!
}
payload_type_format
string
Enum: "scalar" "scalar-list" "generated" "generated-list" "custom"

사용자 지정 해석기가 사용하는 페이로드 유형의 종류입니다. 이 값은 payload_type의 값과 일치해야 합니다.

  • 스칼라 페이로드 유형은 "scalar" 또는 "scalar-list"를 사용해야 합니다.
  • 생성된 페이로드 유형은 "generated" 또는 "generated-list"를 사용해야 합니다.
  • 사용자 지정 페이로드 유형은 다음을 사용해야 합니다. "custom"

정의되지 않은 경우 해석기는 DefaultPayload 객체를 반환합니다.

_id
required
string

사용자 지정 해석기의 고유 ID입니다.

function_id
required
string

해석기 함수의 고유 ID입니다.

Responses

Request samples

Content type
application/json
{
  • "on_type": "string",
  • "field_name": "string",
  • "input_type": "string",
  • "input_type_format": "scalar",
  • "payload_type": "string",
  • "payload_type_format": "scalar",
  • "_id": "string",
  • "function_id": "string"
}

Delete a custom resolver

기존 사용자 지정 해석기 구성을 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

customResolverId
required
string

사용자 지정 해석기의 고유한 _id 값입니다.

Responses

Get validation settings

읽기 및 쓰기에 대한 현재 유효성 검사 수준과 작업을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "read_validation_action": "ERROR",
  • "read_validation_level": "STRICT",
  • "write_validation_action": "ERROR",
  • "write_validation_level": "STRICT"
}

Modify validation settings

읽기 및 쓰기에 대한 유효성 검사 수준과 작업을 설정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

업데이트된 유효성 검사 수준 및 작업입니다.

read_validation_action
string (GraphQLValidationAction)
Enum: "ERROR" "WARN"
read_validation_level
string (GraphQLValidationLevel)
Enum: "STRICT" "OFF"
write_validation_action
string (GraphQLValidationAction)
Enum: "ERROR" "WARN"
write_validation_level
string (GraphQLValidationLevel)
Enum: "STRICT" "OFF"

Responses

Request samples

Content type
application/json
{
  • "read_validation_action": "ERROR",
  • "read_validation_level": "STRICT",
  • "write_validation_action": "ERROR",
  • "write_validation_level": "STRICT"
}

Hosting

애플리케이션의 호스팅된 파일을 관리합니다.

Asset Metadata Document Example

자산 메타데이터 문서는 호스팅된 자산 파일을 설명합니다.

{
  "path": "<Asset Resource Path>",
  "hash": "<Asset MD5 Checksum Hash>",
  "size": <File size in bytes>,
  "attrs": [
      {
        "name": "<Metadata Attribute Name>",
        "value": "<Metadata Attribute Value>",
      }
  ]
}

Get Hosting Configuration

현재 호스팅 구성을 반환합니다. 응답에 status: "setup_ok"가 포함되어 있으면 호스팅이 활성화된 것입니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "status": "setup_ok",
  • "default_domain": {
    }
}

Enable/Disable Hosting

앱에 대한 App Services 호스팅을 활성화하거나 비활성화합니다. 호스팅 변경 사항이 적용되려면 최대 15분 정도 소요될 수 있습니다. 이 엔드포인트는 변경 사항이 적용된 시점을 알리지 않고 서버에서 변경 작업을 성공적으로 수신했다는 것만 알립니다.

호스팅 구성 가져오기 엔드포인트를 호출하여 호스팅 활성화/비활성화가 완료되었는지 확인할 수 있습니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
enabled
boolean

App Services 호스팅을 활성화하려면 true로 설정합니다. App Services 호스팅을 비활성화하려면 false로 설정합니다.

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

List all hosted assets

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Move or copy a hosted asset

호스팅된 자산을 새 리소스 경로로 이동하거나 복사합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

호스팅된 자산 파일과 해당 메타데이터입니다 (Content-Type: multipart/mixed를 사용해야 함).

move_from
string

이동할 자산의 현재 리소스 경로입니다. move_to와 함께 사용해야 합니다.

move_to
string

자산이 이동할 리소스 경로입니다. move_from과 함께 사용해야 합니다.

copy_from
string

복사할 자산의 현재 리소스 경로입니다. copy_to와 함께 사용해야 합니다.

copy_to
string

자산이 복사될 리소스 경로입니다. copy_from과 함께 사용해야 합니다.

Responses

Request samples

Content type
application/json
{
  • "move_from": "string",
  • "move_to": "string",
  • "copy_from": "string",
  • "copy_to": "string"
}

Retrieve metadata for a specific hosted asset

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
path
required
string

호스팅된 자산의 리소스 경로입니다.

prefix
string

리소스 경로가 지정된 접두사로 시작하는 자산만 반환합니다.

Responses

Response samples

Content type
application/json
{
  • "appId": "string",
  • "last_modified": 0,
  • "url": "string",
  • "path": "string",
  • "size": 0,
  • "attrs": [
    ],
  • "hash": "string"
}

Upload or replace a hosted asset

특정 리소스 경로에서 호스팅된 자산을 업로드하거나 교체합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
path
required
string

호스팅된 자산의 리소스 경로입니다.

Request Body schema: application/json

호스팅된 자산 파일과 해당 메타데이터입니다 (Content-Type: multipart/mixed를 사용해야 함).

object (AssetMetadata)

자산 메타데이터 문서(JSON으로 인코딩됨)

file
string <binary>

업로드할 자산 파일입니다(바이너리로 인코딩).

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": "string"
}

Update the metadata attributes of a hosted asset

특정 리소스 경로에서 호스팅된 자산의 메타데이터 속성을 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
path
required
string

호스팅된 자산의 리소스 경로입니다.

Request Body schema: application/json

호스팅된 자산의 새로운 메타데이터 속성입니다. 이러한 속성은 파일의 모든 기존 속성을 대체합니다.

Array of objects (MetadataAttribute)

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": "string"
}

Logs

애플리케이션의 로그에 액세스합니다.

Pagination with the Logging API

로깅 엔드포인트는 페이지당 최대 100개의 로그 항목을 반환합니다. 쿼리가 항목 100개를 초과하여 일치하면 결과가 페이지로 매겨집니다. 이러한 결과에는 동일한 쿼리에 대해 다음 페이지의 항목을 요청하는 데 필요한 두 가지 정보, 즉 nextEndDatenextSkip 필드가 포함됩니다.

페이지가 매겨진 결과에는 항상 nextEndDate 필드가 포함됩니다. 다음 페이지의 첫 번째 항목의 타임스탬프가 현재 페이지의 마지막 항목의 타임스탬프와 동일한 경우 페이지가 매겨진 결과에는 nextSkip 필드도 포함됩니다.

최대 100개의 로그 항목 중 첫 페이지를 요청하려면 평소와 같이 엔드포인트를 사용합니다.

curl --request GET \
  --header 'Authorization: Bearer <access_token>' \
  'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/logs'

최대 100개의 로그 항목으로 구성된 다음 페이지를 요청하려면 nextEndDatenextSkip 값을 각각 end_dateskip 매개변수로 전달합니다.

curl --request GET \
  --header 'Authorization: Bearer <access_token>' \
  'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/logs?end_date={nextEndDate of previous response}&skip={nextSkip of previous response}'

응답에 nextEndDate 필드가 없을 때까지 이 단계를 반복하여 더 많은 페이지를 가져옵니다. 해당 필드가 없으면 마지막 페이지에 도달했음을 의미합니다.

자세한 내용은 /groups/{groupId}/apps/{appId}/logs 가져오기를 참조하세요.

Retrieve App Services logs

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
co_id
string

특정 요청 상관관계 ID와 관련된 로그 메시지만 반환합니다.

errors_only
boolean

이 필드의 값은 중요하지 않습니다. 요청에 포함된 경우 이 엔드포인트는 값이 false로 설정된 경우에도 오류 로그만 반환합니다. 이 필드가 요청에서 제외되면 이 엔드포인트는 오류가 아닌 로그만 반환합니다.

user_id
string

특정 user_id와 관련된 로그 메시지만 반환합니다.

start_date
string

결과 반환을 시작할 ISO 8601의 날짜 및 시간(배타적)입니다.

end_date
string

결과 반환을 중단할 ISO 8601의 날짜 및 시간(포괄적)입니다.

skip
integer

응답에 포함하기 전에 건너뛸 일치 로그 항목의 오프셋 수입니다.

limit
integer [ 1 .. 100 ]

응답에 포함할 최대 로그 항목 수입니다. 쿼리가 이 수보다 많은 로그와 일치하는 경우 한도에 도달할 때까지 날짜별 오름차순으로 문서를 반환합니다.

type
string
Enum: "TRIGGER_FAILURE" "TRIGGER_ERROR_HANDLER" "DB_TRIGGER" "AUTH_TRIGGER" "SCHEDULED_TRIGGER" "FUNCTION" "SERVICE_FUNCTION" "STREAM_FUNCTION" "SERVICE_STREAM_FUNCTION" "AUTH" "WEBHOOK" "ENDPOINT" "PUSH" "API" "API_KEY" "GRAPHQL" "SYNC_CONNECTION_START" "SYNC_CONNECTION_END" "SYNC_SESSION_START" "SYNC_SESSION_END" "SYNC_CLIENT_WRITE" "SYNC_ERROR" "SYNC_OTHER" "SCHEMA_ADDITIVE_CHANGE" "SCHEMA_GENERATION" "SCHEMA_VALIDATION" "LOG_FORWARDER"

조회하려는 로그의 종류입니다.

Responses

Response samples

Content type
application/json
{
  • "logs": [
    ],
  • "nextEndDate": "string",
  • "nextSkip": 0
}

Log Forwarding

애플리케이션의 로그 전달자를 보고 관리합니다.

List log forwarders.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a log forwarder.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

로그 전달자 구성

name
required
string
disabled
required
boolean
log_types
required
Array of strings (LogType)
Items Enum: "auth" "endpoint" "function" "graphql" "push" "schema" "service" "sync" "trigger" "trigger_error_handler"
log_statuses
required
Array of strings (LogStatus)
Items Enum: "error" "success"
required
object (LogForwardingPolicy)
required
object (LogForwardingAction)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "disabled": true,
  • "log_types": [
    ],
  • "log_statuses": [
    ],
  • "policy": {
    },
  • "action": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "log_types": [
    ],
  • "log_statuses": [
    ],
  • "policy": {
    },
  • "action": {
    }
}

Get a specific log forwarder.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

forwarderId
required
string

로그 전달자의 _id ObjectID입니다.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "log_types": [
    ],
  • "log_statuses": [
    ],
  • "policy": {
    },
  • "action": {
    }
}

Update a log forwarder.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

forwarderId
required
string

로그 전달자의 _id ObjectID입니다.

Request Body schema: application/json

로그 전달자 구성

name
required
string
disabled
required
boolean
log_types
required
Array of strings (LogType)
Items Enum: "auth" "endpoint" "function" "graphql" "push" "schema" "service" "sync" "trigger" "trigger_error_handler"
log_statuses
required
Array of strings (LogStatus)
Items Enum: "error" "success"
required
object (LogForwardingPolicy)
required
object (LogForwardingAction)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "disabled": true,
  • "log_types": [
    ],
  • "log_statuses": [
    ],
  • "policy": {
    },
  • "action": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "log_types": [
    ],
  • "log_statuses": [
    ],
  • "policy": {
    },
  • "action": {
    }
}

Delete a log forwarder.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

forwarderId
required
string

로그 전달자의 _id ObjectID입니다.

Responses

Enable a log forwarder.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

forwarderId
required
string

로그 전달자의 _id ObjectID입니다.

Responses

Disable a log forwarder.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

forwarderId
required
string

로그 전달자의 _id ObjectID입니다.

Responses

Metrics

Atlas App Services 지표를 확인합니다.

Retrieve App Services metrics

계산 시간, 데이터 전송, 동기화 시간(분), 성공한 요청, 실패한 요청 등 다양한 지표를 조회합니다. 사용 가능한 지표의 전체 목록은 App Services 지표 참조를 참조하세요.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
start
required
string

쿼리 기간이 시작되는 ISO-8601 날짜 및 시간입니다(예: "2022-10-27T14:01:01Z").

end
required
string

쿼리 기간이 종료되는 ISO-8601 날짜 및 시간입니다(예: "2022-12-27T14:01:01Z").

granularity
required
string

쿼리 기간의 세분성을 ISO-8601 기간 값으로 지정합니다. 예시로는 "P31D"(31일), "PT1H"(1시간), "PT5M"(5분) 등이 있습니다.

metrics
string
Enum: "ACTIVE_OPEN_SYNC_SESSIONS" "AUTH_EGRESS_BYTES" "AUTH_FAILED_REQUESTS" "AUTH_RESPONSE_MS" "AUTH_SUCCESSFUL_LOGIN" "AUTH_SUCCESSFUL_REQUESTS" "AUTH_TOTAL_USERS" "ENDPOINTS_COMPUTE_MS" "ENDPOINTS_EGRESS_BYTES" "ENDPOINTS_FAILED_REQUEST" "ENDPOINTS_RESPONSE_MS" "ENDPOINTS_SUCCESSFUL_REQUESTS" "GRAPHQL_RESPONSE_MS" "GRAPHQL_COMPUTE_MS" "GRAPHQL_EGRESS_BYTES" "GRAPHQL_FAILED_REQUESTS" "GRAPHQL_SUCCESSFUL_REQUESTS" "LF_RESPONSE_MS" "OVERALL_COMPUTE_MS" "OVERALL_EGRESS_BYTES" "OVERALL_FAILED_REQUESTS" "OVERALL_SUCCESSFUL_REQUESTS" "OVERALL_SYNC_MINUTES" "SDK_COMPUTE_MS" "SDK_EGRESS_BYTES" "SDK_FAILED_REQUESTS" "SDK_FNS_RESPONSE_MS" "SDK_MQL_COMPUTE_MS" "SDK_MQL_EGRESS_BYTES" "SDK_MQL_FAILED_REQUESTS" "SDK_MQL_RESPONSE_MS" "SDK_MQL_SUCCESSFUL_REQUESTS" "SDK_SUCCESSFUL_REQUESTS" "SYNC_CLIENT_BOOTSTRAP_MS" "SYNC_CLIENT_UPLOADS_INVALID" "SYNC_CURRENT_OPLOG_LAG_MS_SUM" "SYNC_EGRESS_BYTES" "SYNC_FAILED_REQUESTS" "SYNC_HISTORY_WRITE_MS" "SYNC_MINUTES" "SYNC_NUM_INTEGRATION_ATTEMPTS" "SYNC_NUM_UNSYNCABLE_DOC" "SYNC_OT_MS" "SYNC_SESSIONS_ENDED" "SYNC_SESSIONS_STARTED" "SYNC_SUCCESSFUL_REQUESTS" "SYNC_UPLOAD_PROPS_MS" "TRIGGERS_COMPUTE_MS" "TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" "TRIGGERS_EGRESS_BYTES" "TRIGGERS_FAILED_REQUESTS" "TRIGGERS_RESPONSE_MS" "TRIGGERS_SUCCESSFUL_REQUESTS"

필터링할 지표의 이름입니다. 사용 가능한 지표 및 해당 단위에 대한 자세한 내용은 App Services 지표 참조를 확인하세요.

Responses

Response samples

Content type
application/json
{
  • "measurements": [
    ],
  • "app_id": "string",
  • "app_name": "string",
  • "group_id": "string",
  • "start": "2022-10-27T14:01:01Z",
  • "end": "2022-12-27T14:01:01Z",
  • "granularity": "string"
}

Rules

애플리케이션의 데이터 액세스 규칙을 보고 관리합니다.

Get all rules

모든 데이터 액세스 규칙을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a rule

데이터 액세스 규칙을 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Request Body schema: application/json

생성할 규칙입니다.

One of
_id
string

규칙의 고유 ObjectId 식별자입니다.

Array of objects (Role)

데이터 액세스 역할 목록입니다.

Array of objects (Filter)

수신 작업에 대한 필터 목록입니다.

database
required
string

연결된 데이터 소스에 있는 데이터베이스의 이름입니다.

collection
required
string

지정된 database에 있는 컬렉션의 이름입니다.

Responses

Request samples

Content type
application/json
Example
{
  • "_id": "string",
  • "roles": [
    ],
  • "filters": [
    ],
  • "database": "string",
  • "collection": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string"
}

Get a rule

특정 데이터 액세스 규칙을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

ruleId
required
string

규칙의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
Example
{
  • "_id": "string",
  • "roles": [
    ],
  • "filters": [
    ],
  • "database": "string",
  • "collection": "string"
}

Delete a rule

데이터 액세스 규칙을 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

ruleId
required
string

규칙의 고유한 _id 값입니다.

Responses

Update a rule

데이터 액세스 규칙을 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

ruleId
required
string

규칙의 고유한 _id 값입니다.

Request Body schema: application/json

규칙의 새로운 상태입니다.

One of
_id
string

규칙의 고유 ObjectId 식별자입니다.

Array of objects (Role)

데이터 액세스 역할 목록입니다.

Array of objects (Filter)

수신 작업에 대한 필터 목록입니다.

database
required
string

연결된 데이터 소스에 있는 데이터베이스의 이름입니다.

collection
required
string

지정된 database에 있는 컬렉션의 이름입니다.

Responses

Request samples

Content type
application/json
Example
{
  • "_id": "string",
  • "roles": [
    ],
  • "filters": [
    ],
  • "database": "string",
  • "collection": "string"
}

Get default roles and filters

현재 기본 역할 및 필터를 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ],
  • "filters": [
    ]
}

Create default roles and filters

데이터 소스에 대한 기본 역할 및 필터를 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Request Body schema: application/json

기본 규칙 구성 객체입니다.

Array of objects (RoleConstructor)

기본 사용자 역할의 정렬된 목록입니다.

Array of objects (FilterConstructor)

기본 쿼리 필터 목록입니다.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "roles": [
    ],
  • "filters": [
    ]
}

Update default roles and filters

데이터 소스의 기본 역할 및 필터를 수정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Request Body schema: application/json

업데이트된 기본 규칙 구성 객체입니다.

_id
required
string

기본 규칙의 고유 ObjectId 식별자입니다.

Array of objects (Role)

기본 사용자 역할의 정렬된 목록입니다.

Array of objects (Filter)

기본 쿼리 필터 목록입니다.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "default rule does not exist"
}

Delete default roles and filters

데이터 소스의 기본 역할 및 필터를 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "error": "default rule does not exist for app service"
}

Schemas

애플리케이션의 스키마를 보고 관리합니다.

Sample & Validate Documents

컬렉션의 문서 하위 집합을 쿼리하고 스키마와 비교하여 각 일치 항목의 유효성을 검사합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

datasourceId
required
string

MongoDB 데이터 소스의 고유한 _id 값입니다.

Request Body schema: application/json
database_name
required
string

유효성을 검사할 컬렉션이 포함된 데이터베이스의 이름입니다.

collection_name
required
string

유효성을 검사할 컬렉션의 이름입니다.

from_schema
required
object

샘플링된 문서의 유효성을 검사하기 위한 EJSON 스키마입니다.

query
object
Default: {}

컬렉션의 문서와 일치하는 MongoDB 쿼리입니다. 이 쿼리를 실행한 결과는 샘플 모집단입니다. 이를 사용하여 컬렉션에 있는 문서의 하위 집합으로 샘플 범위를 좁힙니다.

limit
number
Default: 10000

샘플링할 최대 문서 수입니다.

sort
object
Default: {}

컬렉션에 대한 MongoDB 정렬입니다. 이를 사용하여 샘플링을 시작할 범위 쿼리의 끝을 결정합니다.

Responses

Request samples

Content type
application/json
{
  • "database_name": "string",
  • "collection_name": "string",
  • "from_schema": { },
  • "query": { },
  • "limit": 10000,
  • "sort": { }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_processed_count": 0,
  • "total_error_count": 0
}

List schemas

정의된 모든 스키마를 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a schema

연결된 컬렉션에 대한 새 스키마를 정의합니다. 이 엔드포인트로 스키마를 생성할 때 JSON 페이로드가 완전히 이스케이프되지 않았는지 확인합니다. 잘못 이스케이프된 JSON 형식으로 인해 오류가 발생할 수 있습니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
required
object (SchemaMetadata)

메타데이터는 스키마가 적용되는 연결된 컬렉션을 설명합니다.

object (SchemaDefinition)

컬렉션의 유효한 스키마입니다.

object (SchemaRelationships)

외부 컬렉션과의 관계입니다. 각 필드 이름은 스키마의 속성입니다. 해당 값은 해당 필드에 대한 관계 정의입니다.

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "schema": {
    },
  • "relationships": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "metadata": {
    }
}

Get a schema

_id 값으로 특정 스키마를 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

schemaId
required
string

스키마의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "schema": {
    },
  • "relationships": {
    }
}

Update a schema

기존 스키마를 새 스키마로 바꿉니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

schemaId
required
string

스키마의 고유한 _id 값입니다.

Request Body schema: application/json
object (SchemaMetadata)

메타데이터는 스키마가 적용되는 연결된 컬렉션을 설명합니다.

object (SchemaDefinition)

컬렉션의 유효한 스키마입니다.

object (SchemaRelationships)

외부 컬렉션과의 관계입니다. 각 필드 이름은 스키마의 속성입니다. 해당 값은 해당 필드에 대한 관계 정의입니다.

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "schema": {
    },
  • "relationships": {
    }
}

Delete a schema

_id 값으로 특정 스키마를 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

schemaId
required
string

스키마의 고유한 _id 값입니다.

Responses

Get Null Type Schema Validation Setting

null 유형 스키마 유효성 검사가 활성화되어 있는지 확인합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Set Null Type Schema Validation Setting

null 유형 스키마 유효성 검사를 활성화하거나 비활성화합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Secrets

애플리케이션의 시크릿을 보고 관리합니다.

List secrets

Atlas App Services 앱과 연결된 시크릿을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Secret

시크릿을 생성합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

생성할 시크릿입니다.

name
required
string
value
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string"
}

Modify a Secret

Atlas App Services 앱과 연결된 시크릿을 수정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

secretId
required
string

시크릿의 고유한 _id 값입니다.

Request Body schema: application/json

시크릿의 수정된 값입니다.

_id
string
name
required
string
value
required
string

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "value": "string"
}

Delete a Secret

Atlas App Services 앱과 연결된 시크릿을 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

secretId
required
string

시크릿의 고유한 _id 값입니다.

Responses

Security

애플리케이션의 보안을 구성합니다.

List allowed HTTP origins

App Services가 요청을 허용해야 하는 허용된 HTTP 출처를 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Set allowed HTTP origins

App Services가 요청을 허용해야 하는 허용된 HTTP 출처를 설정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

HTTP 출처 목록입니다.

Array
string

HTTP 출처입니다. <scheme>://<host>[:port] 형식이어야 합니다.

Responses

Request samples

Content type
application/json
[
  • "string"
]

List the allowed entries in the Access List

Atlas App Services 앱의 액세스 목록에 허용된 항목을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an IP address or CIDR block in the Access List

App Services 앱의 액세스 목록에서 IP 주소 또는 CIDR 블록을 생성합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

생성할 IP 액세스 목록 항목입니다.

address
required
string

IP 주소 또는 CIDR 블록의 값입니다.

comment
string

액세스 목록 항목에 포함된 선택적 코멘트입니다.

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "address": "string",
  • "ip": "string",
  • "network": "string",
  • "comment": "string"
}

Modify an IP address or CIDR block in the Access List

App Services 앱의 액세스 목록에서 IP 주소 또는 CIDR 블록을 수정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

ipId
required
string

요청 본문에 제공된 정보와 함께 ip_id로 표시된 IP 주소 항목입니다.

Request Body schema: application/json

IP 액세스 목록 항목의 업데이트된 값입니다.

address
required
string

IP 주소 또는 CIDR 블록의 수정된 값입니다.

comment
string

액세스 목록 항목에 포함된 선택적 코멘트입니다.

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "address": "string",
  • "ip": "string",
  • "network": "string",
  • "comment": "string"
}

Delete an IP address or CIDR block from the Access List

App Services 앱의 액세스 목록에서 IP 주소 또는 CIDR 블록을 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

ipId
required
string

요청 본문에 제공된 정보와 함께 ip_id로 표시된 IP 주소 항목입니다.

Responses

List VPC Private Endpoints

앱에 대해 구성된 모든 비공개 엔드포인트의 목록을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a VPC Private Endpoint

앱에 대한 새 비공개 엔드포인트를 구성합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
cloud_provider_region
required
string

비공개 엔드포인트를 호스팅하는 클라우드 공급자 리전입니다.

cloud_provider_endpoint_id
required
string

클라우드 공급자의 비공개 엔드포인트 ID입니다.

comment
string

엔드포인트를 설명하는 선택적 코멘트입니다.

endpoint_type
required
string
Enum: "sync" "general"

엔드포인트의 유형입니다. 엔드포인트 유형과 더 이상 사용되지 않는 엔드포인트를 "general" 또는 "sync"로 마이그레이션하는 방법에 대한 자세한 내용은 VPC 프라이빗 엔드포인트 사용을 참조하세요.

Responses

Request samples

Content type
application/json
{
  • "cloud_provider_region": "aws-us-east-1",
  • "cloud_provider_endpoint_id": "vpce-12345678",
  • "comment": "string",
  • "endpoint_type": "sync"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "cloud_provider_region": "aws-us-east-1",
  • "cloud_provider_endpoint_id": "vpce-12345678",
  • "comment": "string",
  • "endpoint_type": "sync"
}

Get a VPC Private Endpoint

특정 비공개 엔드포인트 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

privateEndpointId
required
string

VPC 비공개 엔드포인트의 _id ObjectID입니다.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "cloud_provider_region": "aws-us-east-1",
  • "cloud_provider_endpoint_id": "vpce-12345678",
  • "comment": "string",
  • "endpoint_type": "sync"
}

Modify a VPC Private Endpoint

비공개 엔드포인트의 구성을 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

privateEndpointId
required
string

VPC 비공개 엔드포인트의 _id ObjectID입니다.

Request Body schema: application/json
cloud_provider_region
required
string

비공개 엔드포인트를 호스팅하는 클라우드 공급자 리전입니다.

cloud_provider_endpoint_id
required
string

클라우드 공급자의 비공개 엔드포인트 ID입니다.

comment
string

엔드포인트를 설명하는 선택적 코멘트입니다.

endpoint_type
required
string
Enum: "sync" "general"

엔드포인트의 유형입니다. 엔드포인트 유형과 더 이상 사용되지 않는 엔드포인트를 "general" 또는 "sync"로 마이그레이션하는 방법에 대한 자세한 내용은 VPC 프라이빗 엔드포인트 사용을 참조하세요.

Responses

Request samples

Content type
application/json
{
  • "cloud_provider_region": "aws-us-east-1",
  • "cloud_provider_endpoint_id": "vpce-12345678",
  • "comment": "string",
  • "endpoint_type": "sync"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "cloud_provider_region": "aws-us-east-1",
  • "cloud_provider_endpoint_id": "vpce-12345678",
  • "comment": "string",
  • "endpoint_type": "sync"
}

Delete a VPC Private Endpoint

비공개 엔드포인트를 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

privateEndpointId
required
string

VPC 비공개 엔드포인트의 _id ObjectID입니다.

Responses

List VPC Private Endpoint Services

앱에 대해 구성된 모든 비공개 엔드포인트 서비스 목록을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Toggle Non-VPC Requests

비공개 엔드포인트가 활성화된 앱의 경우 앱이 VPC 외부에서 발생한 요청을 처리할지 여부를 토글합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
allow_non_vpc_client_requests
boolean

비VPC 요청을 허용하려면 true로 설정합니다. 비VPC 요청을 제한하려면 false로 설정합니다.

Responses

Request samples

Content type
application/json
{
  • "allow_non_vpc_client_requests": true
}

Get User Refresh Token Expiration Time

사용자 세션 새로 고침 토큰의 현재 만료 시간을 초 단위로 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
{
  • "expiration_time_seconds": 5184000
}

Set User Refresh Token Expiration Time

사용자 세션 새로 고침 토큰의 만료 시간을 초 단위로 설정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
expiration_time_seconds
number [ 1800 .. 15552000 ]
Default: 5184000

사용자 세션 새로 고침 토큰이 발급된 후 유효한 시간(초)입니다. 이 시간이 지나면 토큰은 만료되며 사용자는 다시 인증해야 합니다.

만료 시간은 30분에서 5년 사이여야 합니다. 기본 만료 시간은 60일입니다.

Responses

Request samples

Content type
application/json
{
  • "expiration_time_seconds": 5184000
}

Data Sources & Services

애플리케이션의 데이터 소스타사 서비스[사용 중단됨]를 보고 관리합니다.

Link multiple data sources

이 엔드포인트를 호출하여 여러 데이터 소스를 앱에 연결합니다. 앱당 연결된 데이터 소스의 총 한도는 100 입니다. 이 엔드포인트로 연결된 데이터 소스에는 ReadAndWrite 기본 규칙이 있습니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
Array
name
string

연결하려는 각 클러스터를 식별하는 이름을 만듭니다.

type
string
Enum: "mongodb-atlas" "datalake"

연결하려는 데이터 소스의 유형입니다.

object (LinkingDataSourceConfig)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "failedClusterNames": [
    ]
}

List all data sources and third-party services

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a data source or third-party service

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json
One of
name
string

서비스 이름입니다.

type
string

서비스 유형입니다.

object (AtlasClusterServiceConfigInstance)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "type": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "_id": "string",
  • "name": "string",
  • "type": "string",
  • "config": {
    }
}

Get a data source or third-party service

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
Example
{
  • "_id": "string",
  • "name": "string",
  • "type": "string",
  • "config": {
    }
}

Delete a data source or third-party service

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Update a service

서비스를 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Run a command associated with a service

서비스와 관련된 명령을 실행합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

commandName
required
string

명령 이름

Responses

Get information about the underlying Atlas mongod

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "gitVersion": "string",
  • "versionArray": [
    ],
  • "javascriptEngine": "string",
  • "bits": "string",
  • "debug": true,
  • "maxBsonObjectSize": 0
}

Get a Service Configuration

모든 데이터 소스타사 서비스[사용 중단됨]의 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update a Service Configuration

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Request Body schema: application/json
One of
clusterName
required
string

내부 데이터 소스의 클러스터 이름입니다. 이름은 최대 64자 이하여야 하며, ASCII 문자, 숫자, 밑줄 및 하이픈만 포함할 수 있습니다.

readPreference
required
string
Enum: "primary" "primaryPreferred" "secondary" "secondaryPreferred" "nearest"

데이터 소스에 대한 읽기 요청의 읽기 설정 모드입니다.

readPreferenceTagSets
Array of strings (ReadPreferencesTagSet)
Items Enum: "server1" "server2"

복제본 세트의 특정 노드를 대상으로 읽기 작업을 수행합니다.

wireProtocolEnabled
required
boolean

참인 경우 클라이언트는 MongoDB 유선 프로토콜을 통해 앱에 연결할 수 있습니다.

clusterId
number

서비스 ID입니다.

groupName
string

서비스가 포함된 그룹의 이름입니다.

orgName
string

서비스가 포함된 조직의 이름입니다.

Responses

Request samples

Content type
application/json
Example
{
  • "clusterName": "Cluster0",
  • "readPreference": "primary",
  • "readPreferenceTagSets": [
    ],
  • "wireProtocolEnabled": true,
  • "clusterId": "05e821b3975d271289f372e3a",
  • "groupName": "Project 0",
  • "orgName": "MongoDB_Org"
}

Generate a JSON schema from sample

컬렉션에 있는 문서의 하위 집합을 샘플링하여 JSON schema를 생성합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Request Body schema: application/json
database_name
required
string

컬렉션이 포함된 데이터베이스의 이름입니다.

collection_name
required
string

스키마를 샘플링하고 생성할 컬렉션의 이름입니다.

limit
required
integer

샘플에 포함할 문서의 최대 개수입니다.

Responses

Request samples

Content type
application/json
{
  • "database_name": "string",
  • "collection_name": "string",
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "schema": { }
}

Sync

애플리케이션 동기화에 대한 정보를 가져옵니다.

Get Flexible Sync information

Flexible Sync를 사용할 때 특정 Atlas App Services 앱에 대한 동기화 데이터를 조회합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "clusterId": "string",
  • "clusterName": "string",
  • "clusterType": "atlas",
  • "flexible_sync": {
    },
  • "groupName": "string",
  • "orgName": "string",
  • "readPreference": "primary",
  • "wireProtocolEnabled": true
}

Get Partition-Based Sync information

파티션 기반 동기화를 사용할 때 파티션 필드 데이터를 조회합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
service_id
required
string

연결된 클러스터의 서비스 ID입니다.

Responses

Response samples

Content type
application/json
{
  • "service_id": "string",
  • "partition_fields": [
    ]
}

Triggers

애플리케이션의 트리거를 보고 관리합니다.

Get all triggers

애플리케이션의 모든 트리거 목록을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a trigger

애플리케이션에서 새 트리거를 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

데이터베이스, 예정 또는 인증 트리거에 대한 구성입니다.

One of
name
required
string

트리거의 이름입니다.

type
required
string
Value: "DATABASE"

트리거 유형입니다. 데이터베이스 트리거의 경우 이 값은 항상 "DATABASE"입니다.

disabled
boolean
Default: false

true인 경우 트리거가 비활성화되고 이벤트를 수신하거나 실행되지 않습니다.

required
object

트리거에 대한 구성 값을 정의하는 객체입니다.

function_id
string

트리거가 실행될 때 호출하는 함수의 ID입니다.

이 값은 event_processors.FUNCTION.function_id와 동일합니다. 여기 또는 event_processors.FUNCTION.function_id에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.

예를 들어, function_id를 정의하면 백엔드는 이를 event_processors.FUNCTION.function_id에 복제합니다.

function_name
string

트리거가 실행될 때 호출하는 함수의 이름입니다. 즉, function_id에서 설명된 함수입니다.

이 값은 event_processors.FUNCTION.function_name와 동일합니다. 여기 또는 event_processors.FUNCTION.function_name에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.

예를 들어, function_name를 정의하면 백엔드는 이를 event_processors.FUNCTION.function_name에 복제합니다.

object

객체의 각 필드 이름이 이벤트 프로세서 ID이고 각 값이 해당 이벤트 프로세서를 구성하는 객체입니다. 구성 객체 예시는 AWS EventBridge에 트리거 이벤트 전송을 참조하세요.

object

AWS EventBridge 트리거에 대한 사용자 지정 오류 처리를 정의하는 객체입니다. "AWS_EVENTBRIDGE" 이벤트 프로세서가 있는 Atlas Triggers 유형 "DATABASE" 에만 유효합니다.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "onNewEmployee",
  • "type": "DATABASE",
  • "function_id": "5eea9ca4ca0e356e2c2a148a",
  • "config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "name": "onNewEmployee",
  • "type": "DATABASE",
  • "function_id": "5eea9ca4ca0e356e2c2a148a",
  • "config": {
    }
}

Get a trigger

애플리케이션의 기존 트리거에 대한 구성을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

triggerId
required
string

트리거의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
Example
{
  • "name": "onNewEmployee",
  • "type": "DATABASE",
  • "function_id": "5eea9ca4ca0e356e2c2a148a",
  • "config": {
    }
}

Update a trigger

애플리케이션에서 기존 트리거를 수정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

triggerId
required
string

트리거의 고유한 _id 값입니다.

Request Body schema: application/json

업데이트된 트리거 구성입니다.

One of
name
required
string

트리거의 이름입니다.

type
required
string
Value: "DATABASE"

트리거 유형입니다. 데이터베이스 트리거의 경우 이 값은 항상 "DATABASE"입니다.

disabled
boolean
Default: false

true인 경우 트리거가 비활성화되고 이벤트를 수신하거나 실행되지 않습니다.

required
object

트리거에 대한 구성 값을 정의하는 객체입니다.

function_id
string

트리거가 실행될 때 호출하는 함수의 ID입니다.

이 값은 event_processors.FUNCTION.function_id와 동일합니다. 여기 또는 event_processors.FUNCTION.function_id에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.

예를 들어, function_id를 정의하면 백엔드는 이를 event_processors.FUNCTION.function_id에 복제합니다.

function_name
string

트리거가 실행될 때 호출하는 함수의 이름입니다. 즉, function_id에서 설명된 함수입니다.

이 값은 event_processors.FUNCTION.function_name와 동일합니다. 여기 또는 event_processors.FUNCTION.function_name에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.

예를 들어, function_name를 정의하면 백엔드는 이를 event_processors.FUNCTION.function_name에 복제합니다.

object

객체의 각 필드 이름이 이벤트 프로세서 ID이고 각 값이 해당 이벤트 프로세서를 구성하는 객체입니다. 구성 객체 예시는 AWS EventBridge에 트리거 이벤트 전송을 참조하세요.

object

AWS EventBridge 트리거에 대한 사용자 지정 오류 처리를 정의하는 객체입니다. "AWS_EVENTBRIDGE" 이벤트 프로세서가 있는 Atlas Triggers 유형 "DATABASE" 에만 유효합니다.

_id
string

트리거의 고유 ID입니다.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "onNewEmployee",
  • "type": "DATABASE",
  • "function_id": "5eea9ca4ca0e356e2c2a148a",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": "string"
}

Delete a trigger

애플리케이션에서 기존 트리거를 제거합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

triggerId
required
string

트리거의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{ }

Resume a suspended trigger

일시중단된 데이터베이스 트리거를 재개합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

triggerId
required
string

트리거의 고유한 _id 값입니다.

Request Body schema: application/json

작업 재개를 위한 구성 옵션입니다.

disable_token
boolean

true인 경우 누락된 이벤트를 처리하지 않고 트리거를 재개합니다. 그렇지 않으면 실패 후 재개 토큰을 사용하여 첫 번째 변경 이벤트에서 트리거를 재개하려고 시도합니다.

Responses

Request samples

Content type
application/json
{
  • "disable_token": true
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Users

애플리케이션 사용자를 보고 관리합니다.

List users

확인된 사용자 계정을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
after
string

이전에 페이지 매김 요청에 의해 반환된 마지막 사용자의 id입니다.

sort
string

결과를 정렬할 필드 이름입니다. 유효한 값은 기본값인 _id뿐입니다.

desc
boolean

true인 경우 내림차순으로 정렬된 결과를 반환합니다. 지정하지 않거나 false로 설정하면 결과가 오름차순으로 반환됩니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a user

이메일/비밀번호 사용자 계정을 만듭니다.

참고: 이메일/비밀번호 이외의 인증 제공자에 대해서는 관리자 API를 통해 사용자 계정을 생성할 수 없습니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

생성할 사용자

email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "identities": [
    ],
  • "type": "normal",
  • "creation_date": 0,
  • "last_authentication_date": 0,
  • "disabled": true,
  • "data": { }
}

Verify & decode an access token

사용자의 클라이언트 액세스 토큰이 유효한지 확인합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

사용자의 클라이언트 액세스 토큰입니다. 액세스 토큰은 로그인한 애플리케이션 사용자를 나타냅니다. 이것은 관리자 API로 작업하는 데 사용하는 access_token과 동일하지 않습니다.

token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
Example
"token expired"

Get a User

ID별로 특정 사용자 계정을 가져옵니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

userId
required
string

사용자 계정 ID

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "identities": [
    ],
  • "type": "normal",
  • "creation_date": 0,
  • "last_authentication_date": 0,
  • "disabled": true,
  • "data": { }
}

Delete a user

ID로 특정 사용자 계정을 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

userId
required
string

사용자 계정 ID

Responses

Change a user's email

ID별로 이메일/비밀번호 사용자의 이메일 주소를 변경합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

userId
required
string

사용자 계정 ID

Request Body schema: application/json

사용자의 새 이메일 주소입니다.

email
required
string

사용자의 새 이메일입니다.

Responses

Request samples

Content type
application/json
{
  • "email": "new_email@example.com"
}

List a user's devices

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

userId
required
string

사용자 계정 ID

Responses

Response samples

Content type
application/json
[
  • { }
]

Revoke user sessions

사용자의 모든 세션을 취소합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

userId
required
string

사용자 계정 ID

Responses

Enable a user

사용자를 활성화합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

userId
required
string

사용자 계정 ID

Responses

Disable a user

사용자를 비활성화합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

userId
required
string

사용자 계정 ID

Responses

List pending users

대기 중인 사용자 계정 등록을 나열합니다. 호출에서 대기 중인 사용자를 최대 50명까지 반환합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
after
string

대기 중인 사용자의 고유한 _id입니다. List pending users는 한 번에 대기 중인 사용자50명을 반환할 수 있습니다. 추가 결과를 보려면 list pending users에 대해 이전 호출에 나열된 마지막 대기 중인 사용자의 _id를 찾습니다. list pending users를 다시 호출하여 _id를 이후 매개변수에 전달합니다.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Delete a pending email/password authentication user

대기 중인 사용자를 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

email
required
string

이메일 주소

Responses

User Confirmation

내장된 이메일 확인 흐름을 통해 대기 중인 사용자를 확인합니다.

Send a confirmation email

확인 이메일을 보냅니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

email
required
string

이메일 주소

Responses

Confirm a pending user

대기 중인 사용자를 확인합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

email
required
string

이메일 주소

Responses

Rerun a user confirmation workflow

대기 중인 사용자의 확인 워크플로를 다시 실행합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

email
required
string

이메일 주소

Responses

Values

애플리케이션의 을 보고 관리합니다.

List all values defined in an application.

애플리케이션에 정의된 모든 을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Define a Value in an application

애플리케이션에서 을 정의합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

생성할 값입니다.

name
required
string
private
required
boolean
value
required
any (AnyValue)

Any valid JSON value

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "private": true,
  • "value": null
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "private": true,
  • "value": null
}

Retrieve a value definition from an application

애플리케이션에서 정의를 조회합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

valueId
required
string

값의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "private": true,
  • "from_secret": true,
  • "value": null
}

Delete a value defined in an application.

애플리케이션에 정의된 을 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

valueId
required
string

값의 고유한 _id 값입니다.

Responses

Update a value definition in an application

애플리케이션에서 정의를 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

valueId
required
string

값의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

[Deprecated] Push Notifications

애플리케이션의 푸시 알림을 보고 관리합니다.

List push notifications

푸시 알림을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

query Parameters
state
string (MessageState)
Enum: "sent" "draft"

특정 상태의 알림만 나열합니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a push notification

푸시 알림을 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

Request Body schema: application/json

생성할 알림입니다.

label
required
string
message
required
string
topic
required
string
state
required
string (MessageState)
Enum: "sent" "draft"

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "message": "string",
  • "topic": "string",
  • "state": "sent"
}

Retrieve a push notification message

푸시 알림 메시지를 조회합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

messageId
required
string

메시지 ID

Responses

Response samples

Content type
application/json
{
  • "allowed_ips": "string",
  • "appID": "string",
  • "label": "string",
  • "message": "string",
  • "topic": "string",
  • "created": "string",
  • "sent": "string",
  • "state": "sent"
}

Delete a push notification message

푸시 알림 메시지를 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

messageId
required
string

메시지 ID

Responses

Update a push notification

푸시 알림 메시지를 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

messageId
required
string

메시지 ID

Responses

Response samples

Content type
application/json
{
  • "allowed_ips": "string",
  • "appID": "string",
  • "label": "string",
  • "message": "string",
  • "topic": "string",
  • "created": "string",
  • "sent": "string",
  • "state": "sent"
}

Set a push notification's type

푸시 알림 유형을 설정합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

messageId
required
string

메시지 ID

Responses

Send a push notification

푸시 알림을 보냅니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

messageId
required
string

메시지 ID

Responses

[Deprecated] Webhooks

애플리케이션의 웹훅을 보고 관리합니다.

List webhooks

웹훅을 나열합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "function_source": "string",
  • "respond_result": true,
  • "options": {
    }
}

Create a webhook

웹훅을 만듭니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

Request Body schema: application/json

생성할 웹훅입니다.

name
required
string
function_source
required
string
respond_result
required
boolean
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "function_source": "string",
  • "respond_result": true,
  • "options": {
    }
}

Retrieve a webhook

Retrieve a webhook.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

incomingWebhookId
required
string

수신 웹훅의 고유한 _id 값입니다.

Responses

Delete a webhook

웹훅을 삭제합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

incomingWebhookId
required
string

수신 웹훅의 고유한 _id 값입니다.

Responses

Update a webhook

웹훅 을 업데이트합니다.

Authorizations:
tokenAuth
path Parameters
groupId
required
string

Atlas 프로젝트/그룹 ID입니다.

appId
required
string

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

serviceId
required
string

서비스의 고유한 _id 값입니다.

incomingWebhookId
required
string

수신 웹훅의 고유한 _id 값입니다.

Request Body schema: application/json

웹훅의 업데이트된 상태입니다.

name
required
string
function_source
required
string
respond_result
required
boolean
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "function_source": "string",
  • "respond_result": true,
  • "options": {
    }
}