Skip to main content
A newer release of this product is available.

Delete the S3 server configuration for an SVM

Contributors
PDFs

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

Introduced In: 9.7

Deletes the S3 server configuration of an SVM. If the 'delete_all' parameter is set to false, only the S3 server is deleted. Otherwise S3 users and buckets present on the SVM are also deleted. Note that only empty buckets can be deleted. This endpoint returns the S3 server delete job-uuid in response. To monitor the job status follow /api/cluster/jobs/.

  • vserver object-store-server delete

Learn more

Parameters

Name Type In Required Description

delete_all

boolean

query

False

Delete S3 server and associated users and empty buckets.

  • Default value: 1

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Response

Status: 200, Ok
Name Type Description

num_records

integer

Number of Records

records

array[records]
Example response 
{
  "num_records": 1,
  "records": [
    {
      "job": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "uuid": "string"
      }
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

92405864

An error occurs when deleting an S3 user or bucket. The reason for failure is detailed in the error message. Follow the error codes specified for the user or bucket endpoints to see details for the failure.
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.

records

Name Type Description

job

job_link

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.