Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Value(s)

Description and usage

admin

yes/true to activate

Use with requests by the 'admin' user. An override used to rescue content from being stranded with no ability to delete or update it due to an overly restrictive Allow header.

aliasuuid

domain-UUID

Used on an administrative override COPY request to specify the alias UUID (CID) of an existing domain or bucket for the purpose of changing the name. It must be used with the newname argument, which provides the new domain or bucket name. This is used to resolve name collisions that may occur during replication. 

See Resolving Duplicate Domain Names.

checkintegrity

yes/true to activate

Used on a GET of an erasure-coded object to get a summary of what segments exist in the manifest and the locations in the cluster. The body of the request has this information instead of the object.

checkintegrity is a fast and efficient way to check the integrity of an erasure-coded object, for verifying all segments exist before executing a GET.

Swarm responds with 200 (OK) if it finds enough segments to recreate the object; else it returns 412 (Precondition Failed) and error text in the body of the response lists the missing segments.

cid

UUID

A Context Identifier (CID) can be used to access an otherwise inaccessible object. See Accessing Inaccessible Objects with CID.

countreps

yes/true to activate or diskless

Used to have the HEAD return the number and location of online replicas in the cluster. The count returned is for the object manifest for an erasure-coded object.

examine

yes/true to activate

On a GET or HEAD request, triggers an immediate health processor examination of the request object rather than waiting for the health processor to revisit the object as part of the normal cycle.

ignoreerrors

yes/true to activate

Used on an erasure-coded GET request to step over any broken EC sets and generate any data it can. Use of this query argument activates chunked transfer encoding.

recreatecid

domain or bucket alias UUID

Used for certain administrative actions, such as a special POST request to recreate a particular domain or bucket with the specified alias UUID. This is often performed after deleting a domain or bucket that orphans contents. See Restoring Domains and Buckets.

Info

Warning

Do not attempt to use recreatecid as a way method to move bucket contents across domains within the cluster.

redir

yes/true to activate, no/false to inhibit

Asks the request PAN to encourage or inhibit redirection on the request.

verbose

yes/true to activate

Used on a GET or HEAD request to have all relevant headers returned in the response. (v8.1)

Includes a MinRepsheader that reports the number of replicas that exist (applies to wholly replicated objects and segments).

...