Disable a Company

In this article

    You can disable a company with the specified ID or instanceUid.


    To disable a company, send the POST HTTPS request to the URL of the /tenants/{ID}/disable resource.

    Alternatively you can use the /tenants/{ID}/action and /tenants/{instanceUid}/action resources. These resources remain for backward compatibility purposes. We recommend to use the /tenants/{ID}/disable resource.

    HTTP Request

    POST https://<hostname>:1281/v2/tenants/{ID}/disable

    POST https://<hostname>:1281/v2/tenants/{ID}/action

    POST https://<hostname>:1281/v2/tenants/{instanceUid}/action

    Request Headers

    The request header must contain the authorization token.

    Request Body

    If you decide to use the tenants/{id}/action or tenants/{instanceUid}/action resource you must send the disable action property with the null value in the request body:

    {"disable": null}


    The server returns the following response to the client.

    Response Code

    A successfully completed operation returns response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTP headers.




    The length of the response body.


    The media type and syntax of the request body message: application/json; charset=utf-8

    Response Body

    In the response body, Veeam Service Provider Console returns a message for an action.

    Example Disable a Company

    The following example disables a company with ID 2.


    POST https://localhost:1281/v2/tenants/2/disable


    Request Header:

    Content-Type: application/json

    Authorization: Bearer <Access-Token>


    Response Code:

    200 Success


    Response Body:

    "Company has been disabled."