Skip to main content
ZStack
Security & Audit/Security

UpgradeAnhengCapability

Submit an upgrade task. Platform-admin remains in fixed global scope; project-admin scope is derived from exactly one Enabled Project. Because upgrade manages Cloud resources, the BFF must supply the platform-admin caller's global session. The frontend does not send ProjectID and the session is never logged, audited, persisted, or returned in errors.

POST/api/v1/security/anheng/instances/{instanceUuid}/upgrade

Operation ID

UpgradeAnhengCapability

Since

1.2.8

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • instanceUuid
    StringRequired

    Unique UUID of the instance

Body Fields

  • targetSpecCode
    StringRequired

    Target spec code for this resource

    Example: value

  • quotaItems
    ListRequired

    Quota items for this resource

    Example: (nested array)

    • quotaItemCode
      String

      Quota item code for this resource

      Example: value

    • displayName
      String

      Display name for this resource

      Example: value

    • valueType
      String

      Value type for this resource

      Example: value

    • value
      String

      Value for this resource

      Example: value

    • required
      Boolean

      Required for this resource

      Example: true

    • defaultValue
      String

      Default value for this resource

      Example: value

    • min
      String

      Minimum value allowed by this quota

      Example: 10

    • max
      String

      Maximum value allowed by this quota

      Example: 10

    • unit
      String

      Measurement unit used by this quota

      Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • taskId
    String

    Task id for this resource

    Example: b8b4f3de49de4384a3de0aa0d71d6f31

  • domain
    String

    Domain for this resource

    Example: security.anheng

  • resourceType
    String

    Resource type for this resource

    Example: anheng_instance

  • resourceUuid
    String

    Resource uuid for this resource

    Example: instance-uuid

  • taskType
    String

    Task type for this resource

    Example: open

  • taskState
    String

    Task state for this resource

    Example: running

  • currentStep
    String

    Current step for this resource

    Example: create_cloud_vm

  • failedStep
    String

    Failed step for this resource

    Example: create_cloud_vm

  • retryOfTaskId
    String

    Retry of task id for this resource

    Example: original-task-uuid

  • retryFromStep
    String

    Retry from step for this resource

    Example: create_cloud_vm

  • requestId
    String

    Request id for this resource

    Example: request-123

  • steps
    List

    Steps for this resource

    Example: (nested array)

    • stepCode
      String

      Step code for this resource

      Example: create_cloud_vm

    • status
      String

      Status for this resource

      Example: running

    • errorCode
      String

      Error code for this resource

      Example: ANHENG_CLOUD_SESSION_REQUIRED

    • errorMessage
      String

      Error message for this resource

      Example: Cloud session is required to continue this task

    • startedAt
      String

      Started at for this resource

      Example: 2026-01-15T08:00:00Z

    • finishedAt
      String

      Finished at for this resource

      Example: 2026-01-15T08:00:00Z

  • blockedReasons
    List

    Blocked reasons for this resource

    Example: (nested array)

    • code
      String

      Machine-readable reason or status code

      Example: ANHENG_CLOUD_SESSION_REQUIRED

    • message
      String

      Message for this resource

      Example: Cloud session is required to continue this task

    • source
      String

      Source for this resource

      Example: security.anheng

    • severity
      String

      Severity for this resource

      Example: error

    • retryable
      Boolean

      Retryable for this resource

      Example: true

  • retryable
    Boolean

    Retryable for this resource

    Example: true

  • createdAt
    String

    Created at for this resource

    Example: 2026-01-15T08:00:00Z

  • updatedAt
    String

    Updated at for this resource

    Example: 2026-01-15T08:00:00Z

  • finishedAt
    String

    Finished at for this resource

    Example: 2026-01-15T08:00:00Z

Change History

View all change history

  • Change Time

    AddedRequest parameters X-ZStack-Session
    View API