Create enrollment token

edit

Creates an enrollment token.

Request

edit

POST /api/v1/platform/configuration/security/enrollment-tokens

Request body

edit

(EnrollmentTokenRequest) (required) Request parameters for the enrollment token

Responses

edit
200

(RequestEnrollmentTokenReply) A token has been generated that can be used to start new servers with the requested roles

400

(BasicFailedReply) The token request format was invalid, details in the error (code: 'enrollment_tokens.invalid_token_request')

403

(BasicFailedReply) No signing key is available to generate a token (code: 'enrollment_tokens.signing_key_not_found')

449

(BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPOST https://{{hostname}}/api/v1/platform/configuration/security/enrollment-tokens \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "persistent" : true,
   "roles" : [
      "string"
   ],
   "validity_in_seconds" : 0
}
'