Provision project memory runtime

POST /api/v1/projects/{id}/memory/runtime

Provisions the independent memory-only project TenantEnvironment runtime and requests a best-effort project runtime secret refresh. The response does not prove ESO fetched values or pods restarted.

Path parameters

  • id string Required

    Project ID

Responses

  • Unsupported or malformed API version, an operation unavailable in the selected published contract, or an unacceptable representation (including unsupported media-type parameters or excluded SSE). Existing authentication, authorization, and rate-limit failures take precedence.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Fields with validation failures.

        Hide fields attributes Show fields attributes object

        A field and its validation failure.

        • description string Required

          Human-readable validation failure.

        • field string Required

          Name or path of the invalid request field.

    • detail string Required

      Human-readable error details.

    • error integer Required

      HTTP status code.

    • errorCode string Required

      Machine-readable error code.

    • parameters array[string]

      Request parameter names associated with the error; omitted when none apply.

    • reason string Required

      HTTP status reason phrase.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Fields with validation failures.

        Hide fields attributes Show fields attributes object

        A field and its validation failure.

        • description string Required

          Human-readable validation failure.

        • field string Required

          Name or path of the invalid request field.

    • detail string Required

      Human-readable error details.

    • error integer Required

      HTTP status code.

    • errorCode string Required

      Machine-readable error code.

    • parameters array[string]

      Request parameter names associated with the error; omitted when none apply.

    • reason string Required

      HTTP status reason phrase.

  • 200

    Already provisioned — current status returned

    Hide response attributes Show response attributes object
    • blocked_on string
    • memory_image string

      MemoryImage is the image the runtime is currently pinned to.

    • message string
    • resolved_memory_image string

      ResolvedMemoryImage is the image this environment would pin right now.

    • state string
    Hide response attributes Show response attributes object
    • blocked_on string
    • memory_image string

      MemoryImage is the image the runtime is currently pinned to.

    • message string
    • resolved_memory_image string

      ResolvedMemoryImage is the image this environment would pin right now.

    • state string
  • 202

    Provisioning requested — poll GET to track progress

    Hide response attributes Show response attributes object
    • blocked_on string
    • memory_image string

      MemoryImage is the image the runtime is currently pinned to.

    • message string
    • resolved_memory_image string

      ResolvedMemoryImage is the image this environment would pin right now.

    • state string
    Hide response attributes Show response attributes object
    • blocked_on string
    • memory_image string

      MemoryImage is the image the runtime is currently pinned to.

    • message string
    • resolved_memory_image string

      ResolvedMemoryImage is the image this environment would pin right now.

    • state string
  • Bad Request

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • Unauthorized

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • Forbidden

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • Precondition Failed

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • Internal Server Error

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
POST /api/v1/projects/{id}/memory/runtime
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/projects/{id}/memory/runtime' \
 --header "Authorization: $API_KEY"
Response examples (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"
}
Response examples (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"
}
Response examples (200)
{
  "blocked_on": "string",
  "memory_image": "string",
  "message": "string",
  "resolved_memory_image": "string",
  "state": "string"
}
Response examples (200)
{
  "blocked_on": "string",
  "memory_image": "string",
  "message": "string",
  "resolved_memory_image": "string",
  "state": "string"
}
Response examples (202)
{
  "blocked_on": "string",
  "memory_image": "string",
  "message": "string",
  "resolved_memory_image": "string",
  "state": "string"
}
Response examples (202)
{
  "blocked_on": "string",
  "memory_image": "string",
  "message": "string",
  "resolved_memory_image": "string",
  "state": "string"
}
Response examples (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (401)
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (401)
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (412)
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (412)
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (500)
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (500)
{
  "code": "string",
  "error": "string",
  "success": true
}