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.

« Create a role Get role »

› › › ›

Delete role

edit

Delete role

edit

Delete a role.

Request

edit

DELETE /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.

Query parameters

edit

Name	Type	Required	Description
`skip_validations`	`boolean`; default: `false`	N	When sent as true, ignores validation errors.
`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)

Responses

edit

200

(EmptyResponse) The role was successfully deleted.

400

(BasicFailedReply) The role is currently running container sets. (code: roles.in_use)

Headers

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

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

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

Request example

edit

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

« Create a role Get role »