Skip to main content
ZStack
Recently Deleted/Recently Deleted

CreateEnrollmentInvitation

Create an installation invitation with agent.deploy permission. The enrollment code is returned only by the first successful creation. Initial host_metrics selection also requires agent.config.write.

POST/api/v1/lifecycle/managed-agent/enrollment-invitations

Operation ID

CreateEnrollmentInvitation

Since

1.3.0

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

Body Fields

  • requestId
    String

    Request id for this resource

    Example: value

  • scope
    Object

    Scope for this resource

    • platformUuid
      String

      Platform uuid for this resource

      Example: value

    • regionUuid
      String

      Region uuid for this resource

      Example: value

  • displayName
    String

    Display name for this resource

    Example: value

  • initialCapabilityId
    String

    Omit for management-only installation. Only host_metrics is supported.

    Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • invitationId
    String

    Invitation id for this resource

    Example: value

  • taskId
    String

    Task id for this resource

    Example: value

  • enrollmentCode
    String

    Sensitive, returned only on first creation; never log the response body.

    Example: value

  • expiresAt
    String

    Expires at for this resource

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

  • install
    Object

    Install for this resource

    • 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