GetEnrollmentInvitation

On success, this API returns the following response structure.

• invitationId

  String

  Invitation id for this resource

  Example: value

• state

  String

  This state always belongs to the invitation, not its attempt or tasks.

  Example: value

• expiresAt

  String

  Expires at for this resource

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

• agentId

  String

  Empty until a ManagedAgent has actually been registered.

  Example: value

• enrollmentAttempt

  Object

  Enrollment attempt for this resource

  Show child properties
  • attemptId

    String

    Attempt id for this resource

    Example: value

  • state

    String

    State for this resource

    Example: value

  • expiresAt

    String

    Expires at for this resource

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

  • firstConnectedAt

    String

    First connected at for this resource

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

  • completedAt

    String

    Completed at for this resource

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

  • errorReason

    String

    Error reason for this resource

    Example: value

• deployTask

  Object

  Deploy task for this resource

  Show child properties
  • taskId

    String

    Task id for this resource

    Example: value

  • type

    String

    Persisted enrollment task kind: deploy for Agent installation or enable_capability for initial capability activation.

    Example: value

  • state

    String

    State for this resource

    Example: value

  • capabilityId

    String

    Capability id for this resource

    Example: value

  • errorCode

    String

    Error code for this resource

    Example: value

  • errorReason

    String

    Error reason for this resource

    Example: value

  • errorMessage

    String

    Error message for this resource

    Example: value

  • traceId

    String

    Trace id for this resource

    Example: value

  • startedAt

    String

    Started at for this resource

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

  • completedAt

    String

    Completed at for this resource

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

  • errorDetails

    Object

    Present only for the saved 10012 deployment error.

    Show child properties
    • deployment_phase

      String

      Deployment_phase for this resource

      Example: value

    • invitation_consumed

      Boolean

      Invitation_consumed for this resource

      Example: true

    • registered_agent_id

      Object

      The server emits only a string or JSON null, never a reserved Agent ID.

    • recovery_action

      String

      Recovery_action for this resource

      Example: value

• initialCapabilityTask

  Object

  Initial capability task for this resource

  Show child properties
  • taskId

    String

    Task id for this resource

    Example: value

  • type

    String

    Persisted enrollment task kind: deploy for Agent installation or enable_capability for initial capability activation.

    Example: value

  • state

    String

    State for this resource

    Example: value

  • capabilityId

    String

    Capability id for this resource

    Example: value

  • errorCode

    String

    Error code for this resource

    Example: value

  • errorReason

    String

    Error reason for this resource

    Example: value

  • errorMessage

    String

    Error message for this resource

    Example: value

  • traceId

    String

    Trace id for this resource

    Example: value

  • startedAt

    String

    Started at for this resource

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

  • completedAt

    String

    Completed at for this resource

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

  • errorDetails

    Object

    Present only for the saved 10012 deployment error.

    Show child properties
    • deployment_phase

      String

      Deployment_phase for this resource

      Example: value

    • invitation_consumed

      Boolean

      Invitation_consumed for this resource

      Example: true

    • registered_agent_id

      Object

      The server emits only a string or JSON null, never a reserved Agent ID.

    • recovery_action

      String

      Recovery_action for this resource

      Example: value

• displayName

  String

  Display name for this resource

  Example: value

• scope

  Object

  Scope for this resource

  Show child properties
  • platformUuid

    String

    Platform uuid for this resource

    Example: value

  • regionUuid

    String

    Region uuid for this resource

    Example: value

• install

  Object

  Locally generated installation template, without a code or bin link. Absent when no installation-description source is configured.

  Show child properties
  • scriptUrl

    String

    HTTPS download template: /install/{os}/{arch}?invitationId=. The literal placeholders are filled by the target machine's uname values.

    Example: https://example.com/callback

  • sha256

    String

    Legacy immutable-script source only; absent for rendered Depot scripts. A rendered script has no stable execution-before-download digest.

    Example: value

• initialCapabilityId

  String

  Original installation selection, retained even after invitation expiry. Absent for management-only installation; not the effective capability state.

  Example: value