- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- DeletionRetention
- Try it!
Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations, a soft-deletion is performed. The organization can be restored within the soft-deletion period - which can be controlled using the retention field in the request.
HTTP request
DELETE https://apigee.googleapis.com/v1/{name=organizations/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. Name of the organization. Use the following structure in your request: Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
retention |
Optional. This setting is only applicable for organizations that are soft-deleted (i.e. BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Operation
.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
DeletionRetention
Data retention settings for deleting Organizations.
Enums | |
---|---|
DELETION_RETENTION_UNSPECIFIED |
Default data retention settings will be applied. |
MINIMUM |
Organization data will be retained for the minimum period of 24 hours. |