Skip to main content
ZStack
Recently Deleted/Recently Deleted

StartEnrollment

Start Agent registration using the installation code in the body. Source limits and code authentication are mandatory; Bearer authentication is not used. The response contains a sensitive short-lived session.

POST/api/v1/lifecycle/managed-agent/enrollments

Operation ID

StartEnrollment

Since

1.3.0

Execution Mode

Synchronous

Auth Context

No auth required

Request Inputs

application/json

Body Fields

  • requestId
    StringRequired

    Client-generated UUID reused with the same request body after a lost response.

    Example: 7a91f507-c563-42a7-8b42-cb6b2c12f319

  • enrollmentCode
    StringRequired

    Required one-time enrollment credential from the invitation. Send it in the request body, never in a URL, logs or command-line arguments.

    Example: {enrollmentCode}

  • platform
    Object

    Platform for this resource

    • os
      String

      Target machine operating system distribution identifier, such as rocky or ubuntu, used with version and arch to verify Agent release compatibility.

      Example: value

    • version
      String

      Version for this resource

      Example: value

    • arch
      String

      Target machine CPU architecture used to select the Agent payload, such as x86_64 (amd64) or aarch64 (arm64).

      Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • attemptId
    String

    Attempt id for this resource

    Example: value

  • reservedAgentId
    String

    This is reserved, not an Active ManagedAgent identity yet.

    Example: value

  • enrollmentSession
    String

    Explicit sensitive delivery only; never log or trace this response.

    Example: value

  • agentPackage
    Object

    Agent package for this resource

    • agentVersion
      String

      Agent version for this resource

      Example: value

    • sha256
      String

      Sha256 for this resource

      Example: value

    • release
      String

      Release for this resource

      Example: 10

    • signatureKeyId
      String

      Signature key id for this resource

      Example: value

    • signature
      String

      Signature for this resource

      Example: value

Change History

View all change history

  • Change Time

    AddedResponse fields releaseDeletedResponse fields releaseSequence
    View API