Skip to main content
REST API reference

Delete an S3 bucket configuration for an SVM

PDFs

DELETE /protocols/s3/services/{svm.uuid}/buckets/{uuid}

Introduced In: 9.7

Deletes the S3 bucket configuration of an SVM. An access policy is also deleted on an S3 bucket "delete" command. All CORS rules are also deleted on bucket deletion.

  • vserver object-store-server bucket delete

  • vserver object-store-server bucket policy statement delete

  • vserver object-store-server bucket policy-statement-condition delete

  • vserver object-store-server bucket lifecycle-management-rule delete

  • vserver object-store-server bucket cors-rule delete

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

The unique identifier of the bucket.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Response

Status: 200, Ok
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error code Message

92405811

"Failed to delete bucket "{bucket name}" for SVM "{svm.name}". Wait a few minutes and try the operation again.";

92405858

"Failed to "delete" the "bucket" because the operation is only supported on data SVMs.";

92405861

"The specified SVM UUID or bucket UUID does not exist.";

92405779

"Failed to remove bucket "{bucket name}" for SVM "{svm.name}". Reason: {Reason for failure}. ";

92405813

"Failed to delete the object store volume. Reason: {Reason for failure}.";

92405864

"An error occurred when deleting an access policy. The reason for failure is detailed in the error message.";
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.