Disables the security deployment

edit

DEPRECATED (Scheduled to be removed in the next major version): Disables the existing security deployment configuration.

Request

edit

POST /api/v1/platform/configuration/security/deployment/_disable

Query parameters

edit
Name Type Required Description

version

string

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 security deployment was successfully disabled

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
404

(BasicFailedReply) The realm specified by {realm_id} cannot be found. (code: security_deployment.not_found)

Headers

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

(BasicFailedReply) There is a version conflict. (code: security_deployment.version_conflict)

Headers

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

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

Request example

edit
curl -XPOST https://{{hostname}}/api/v1/platform/configuration/security/deployment/_disable \
-H "Authorization: ApiKey $ECE_API_KEY"