Docs
Elastic Cloud Enterprise Reference [2.2] » RESTful API » API reference » Platform - Configuration - Security
«  Platform - Configuration - Instances - CRUD     Platform - Configuration - Security Deployment  »

Platform - Configuration - Security

Get enrollment tokens

Retrieves a list of active enrollment tokens.

Request

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

Responses

200
(ListEnrollmentTokenReply) The enrollment token is created. Use the token to start new servers with the requested roles.
449
(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')
Warning

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

Request example

curl -XGET {{hostname}}/api/v1/platform/configuration/security/enrollment-tokens \
-u $CLOUD_USER:$CLOUD_KEY

Create enrollment token

Creates an enrollment token.

Request

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

Request body

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

Responses

200
(RequestEnrollmentTokenReply) The enrollment token is created. Use the token to start new servers with the requested roles.
400
(BasicFailedReply) The token request format is invalid. For details, refer to the error. (code: 'enrollment_tokens.invalid_token_request')
403
(BasicFailedReply) The signing key is unavailable. Use a different key, then try again. (code: 'enrollment_tokens.signing_key_not_found')
449
(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')
Warning

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

Request example

curl -XPOST {{hostname}}/api/v1/platform/configuration/security/enrollment-tokens \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "persistent" : true,
   "roles" : [
      "string"
   ],
   "validity_in_seconds" : 0
}
'

Delete enrollment token

Revokes and deletes the enrollment token.

Request

DELETE /api/v1/platform/configuration/security/enrollment-tokens/{token}

Path parameters

Name Type Required Description

token

string

Y

The token or token identifier to revoke.

Responses

200
(EmptyResponse) The enrollment token is unavailable. To start services on new servers, use a different token.
404
(BasicFailedReply) The token can't be found. (code: 'enrollment_tokens.invalid_token_id')
449
(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')
Warning

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

Request example

curl -XDELETE {{hostname}}/api/v1/platform/configuration/security/enrollment-tokens/{token} \
-u $CLOUD_USER:$CLOUD_KEY
«  Platform - Configuration - Instances - CRUD     Platform - Configuration - Security Deployment  »