It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Delete role Update role »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.11] ›RESTful API ›API reference ›Roles

Get role

edit

Get role

edit

Retrieve a role.

Request

edit

GET /api/v1/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}

Path parameters

edit
Name Type Required Description

blueprinter_role_id

string

Y

User-specified Blueprinter role ID.

Responses

edit
200

(RoleAggregate) The role aggregate definition.

404

(BasicFailedReply) The role can't be found. (code: roles.not_found)

Headers

x-cloud-error-codes (string; allowed values: [roles.not_found])
The error codes associated with the response

Request example

edit
curl -XGET https://{{hostname}}/api/v1/platform/infrastructure/blueprinter/roles/{blueprinter_role_id} \
-H "Authorization: ApiKey $ECE_API_KEY"
« Delete role Update role »