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.

« Update role Add Blessing »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.10] ›RESTful API ›API reference ›Roles

Set blessings

edit

Set blessings

edit

Set blessings for a role.

Request

edit

PUT /api/v1/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings

Path parameters

edit
Name Type Required Description

blueprinter_role_id

string

Y

User-specified Blueprinter role ID.

Query parameters

edit
Name Type Required Description

version

integer

N

When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Request body

edit

(Blessings) (required) The blessings to set.

Responses

edit
200

(RoleAggregate) The blessings were successfully set.

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
409

(BasicFailedReply) Your request failed because the specified version does not match the persisted version. (code: roles.version_conflict)

Headers

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

Request example

edit
curl -XPUT https://{{hostname}}/api/v1/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "runner_ids_to_blessing" : {
      "some_property" : {
         "value" : true
      }
   }
}
'
« Update role Add Blessing »