Delete Company Site Resource
You can delete a company site resource 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}/sites/{siteUid} resource. Additionally you must create a query string that defines whether deleted company backups are removed.
HTTP Request
DELETE https://<hostname>:1280/api/v3/organizations/companies/{companyUid}/sites/{siteUid}?removeBackups=true |
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 |
siteUid | Path | String (uuid) | Yes | — | Site UID |
removeBackups | Query | Boolean | Yes | — | Defines whether 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
The following request deletes a site resource with UID 10d0954f-714d-4869-a66a-58bf4ae9828e
Request: DELETE https://localhost:1280/api/v3/organizations/companies/debcdb55-afbd-4772-bf99-5ea6a3249f43/sites/10d0954f-714d-4869-a66a-58bf4ae9828e
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK |