작업 공간 시크릿 생성 또는 업데이트

PUT /api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name}
베어러 인증

시크릿 이름의 유효성을 검사하고 작업 공간으로 범위가 지정된 ECP에 업서트 요청 프록시합니다. 프로젝트 범위는 경로 ID 경로 매개 변수에 의해 전달되며 조직은 해당 프로젝트 에서 파생됩니다. 세션 JWT 또는 프로젝트 범위 API 키를 허용하므로 CI/CD는 대화형 로그인 없이 단기 빌드 자격 증명 시드할 수 있습니다. API 키는 경로에 명명된 프로젝트 로 범위를 지정해야 합니다. 호출자에게는 해당 프로젝트 에 대한 배포 관리 권한(에이전트 엔진 네이티브 프로젝트의 경우 PROJECT_OWNER, AGENT_DEVELOPER, ORG_ADMIN 또는 SYSTEM_ADMIN)이 필요합니다.

경로 매개변수

  • id 문자열 필수 사항

    프로젝트 ID

  • Workspace_id 문자열 필수 사항

    작업 공간 ID

  • 이름 문자열 필수 사항

    시크릿 이름(대문자 env-var 스타일)

application/json

body 필수 사항

시크릿 값 및 설명(선택 사항)

  • description 문자열
  • value 문자열
  • value_unchanged 부울

    ValueUnchanged는 호출자가 기존 시크릿에 대한 설명만 편집하여 명시적으로 설정하다 해야 합니다. 값을 비워 둘 수 있습니다. 이 값이 없으면 빈 값이 항상 거부되며, " 실수(예: 템플릿 버그 또는 설정되지 않은 환경 변수)로 인해 이전 값을 조용히 유지하는 대신 명확한 400를 얻습니다.

응답

  • 406

    지원되지 않거나 잘못된 API 버전, 선택한 게시된 계약에서 사용할 수 없는 작업 또는 허용되지 않는 표현(지원되지 않는 미디어 유형 매개변수 또는 제외된 SSE 포함). 기존 인증, 권한 부여 및 속도 제한 실패가 우선적으로 적용됩니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      표준 오류 스키마 에 정의된 선택적 유효성 검사 세부 정보입니다. API 협상 오류는 이 필드 내보내지 않습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        유효성 검사 에 실패한 필드입니다.

        필드 속성 숨기기 필드 속성 표시 객체

        필드 및 해당 유효성 검사 실패.

        • description 문자열 필수 사항

          사람이 읽을 수 있는 유효성 검사 실패.

        • 필드 문자열 필수 사항

          잘못된 요청 필드 의 이름 또는 경로입니다.

    • 세부 정보 문자열 필수 사항

      사람이 읽을 수 있는 오류 세부 정보.

    • 오류 integer 필수 사항

      HTTP status code.

    • 오류 코드 문자열 필수 사항

      기계가 읽을 수 있는 오류 코드입니다.

    • 매개변수 array[string]

      오류와 관련된 요청 매개변수 이름입니다. 적용 않는 경우 생략됩니다.

    • 이유 문자열 필수 사항

      HTTP 상태 이유 구문입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      표준 오류 스키마 에 정의된 선택적 유효성 검사 세부 정보입니다. API 협상 오류는 이 필드 내보내지 않습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        유효성 검사 에 실패한 필드입니다.

        필드 속성 숨기기 필드 속성 표시 객체

        필드 및 해당 유효성 검사 실패.

        • description 문자열 필수 사항

          사람이 읽을 수 있는 유효성 검사 실패.

        • 필드 문자열 필수 사항

          잘못된 요청 필드 의 이름 또는 경로입니다.

    • 세부 정보 문자열 필수 사항

      사람이 읽을 수 있는 오류 세부 정보.

    • 오류 integer 필수 사항

      HTTP status code.

    • 오류 코드 문자열 필수 사항

      기계가 읽을 수 있는 오류 코드입니다.

    • 매개변수 array[string]

      오류와 관련된 요청 매개변수 이름입니다. 적용 않는 경우 생략됩니다.

    • 이유 문자열 필수 사항

      HTTP 상태 이유 구문입니다.
  • 200

    확인
  • 400

    잘못된 요청

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 403

    Forbidden

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 404

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 413

    엔터티가 너무 큼 요청

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 429

    요청이 너무 많음

    헤더 속성 숨기기 헤더 속성 표시
    • 재시도 후 문자열

      재시도 전 대기 시간(초)

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 502

    잘못된 게이트웨이

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 503

    서비스를 사용할 수 없음

    헤더 속성 숨기기 헤더 속성 표시
    • 재시도 후 문자열

      재시도 전 대기 시간(초)

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
PUT /api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name} 
curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "description": "string",
  "value": "string",
  "value_unchanged": true
}'
요청 예시 
{
  "description": "string",
  "value": "string",
  "value_unchanged": true
}
응답 예시(406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
응답 예시(406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
응답 예시(200) 
{}
응답 예시(200) 
{}
응답 예시(400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(413) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(413) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(429) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(429) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(503) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(503) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}