Delete a portal

DELETE /api/portal/remove

Request

Deletes a portal with a name specified in the request.

Headers

Acceptenum of string

Can be one of: application/json.

Query

portalNamestringrequired

Portal name

Examples

DELETE /api/portal/remove?portalName=example HTTP/1.1
Accept: application/json
Host: example.com

curl --request DELETE \
  --url 'https://example.com/api/portal/remove?portalName=example' \
  --header 'Accept: application/json'

Responses

200

The description of the portal to be deleted

400

Bad Request

errorenum of string

• params - An error has been made in the method parameters specified in the request.
• passPolicyError - The password specified in the request does not meet the requirements.
• portalNameEmpty - The required parameter portalName, which must be present in the request, is not specified.
• portalNameExist - Portal with the portal name specified in the request has already been registered.
• portalNameIncorrect - Invalid characters in the portalName parameter.
• portalNameNotFound - No portal with the portal name specified in the request has been registered.
• portalsCountTooMuch - The limit for the number of portals has been reached.
• recaptchaInvalid - Invalid reCAPTCHA value has been entered.
• tooMuchAttempts - The limit for the number of request attempts has been reached.
• tooShortError - The portalName specified in the request is too short.

Can be one of: params, passPolicyError, portalNameEmpty, portalNameExist, portalNameIncorrect, portalNameNotFound, portalsCountTooMuch, recaptchaInvalid, tooMuchAttempts, tooShortError.

403

Forbidden

errorenum of string

• authorization - Authorization error, the possible reasons: an unknown authorization scheme is used, or the authorization key is missing, or the authorization key time is out, or a wrong key is used.

Can be one of: authorization.

500

Internal Server Error

errorenum of string

• authorization - Internal server error when decoding the authorization key.
• registerNewTenantError - An error occurred while registering a new portal.
• error - An internal server error occurred.

Can be one of: authorization, registerNewTenantError, error.