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

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

Request example

edit
curl -XGET {{hostname}}/api/v1/platform/infrastructure/blueprinter/roles/{blueprinter_role_id} \
-H "Authorization: ApiKey $ECE_API_KEY"