Delete Company

You can delete a company with the specified UID.

Required Privileges

To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator.

Request

To delete a company, send the DELETE HTTP request to the URL of the /organizations/companies/{companyUid} resource.

HTTP Request

DELETE https://<hostname>:1280/api/v3/organizations/companies/{companyUid}

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Accept

Optional

application/json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Request parameters

A list of parameters that are applicable for this operation:

Name

In

Type

Required

Default

Description

companyUid

Path

String (uuid)

Yes

Company UID

removeAllAgents

Query

Boolean

Yes

Defines if all agents installed on the computers in the company infrastructure must be deleted

removeBackups

Query

Boolean

Yes

Defines if all backup files of a company must be deleted

Response

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.

Header

Description

Content-length

The length of the response body.

Content-type

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

Example Delete Company

The following request deletes a company with UID 304c08c2-0d13-4e9d-b26b-0bd5add83b3b.

Request:

DELETE https://localhost:1280/api/v3/organizations/companies/304c08c2-0d13-4e9d-b26b-0bd5add83b3b

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 OK

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.