Volume Settings

curl --request PATCH \
  --url https://{host}/api/volumes/{owner}/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "allow_download": true,
  "allow_preview": true,
  "watermark": true,
  "watermark_text": "<string>"
}
'

import requests

url = "https://{host}/api/volumes/{owner}/{name}"

payload = {
    "description": "<string>",
    "allow_download": True,
    "allow_preview": True,
    "watermark": True,
    "watermark_text": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    allow_download: true,
    allow_preview: true,
    watermark: true,
    watermark_text: '<string>'
  })
};

fetch('https://{host}/api/volumes/{owner}/{name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/volumes/{owner}/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'allow_download' => true,
    'allow_preview' => true,
    'watermark' => true,
    'watermark_text' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/volumes/{owner}/{name}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"allow_download\": true,\n  \"allow_preview\": true,\n  \"watermark\": true,\n  \"watermark_text\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{host}/api/volumes/{owner}/{name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"allow_download\": true,\n  \"allow_preview\": true,\n  \"watermark\": true,\n  \"watermark_text\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/volumes/{owner}/{name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"allow_download\": true,\n  \"allow_preview\": true,\n  \"watermark\": true,\n  \"watermark_text\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PATCH

api

volumes

{owner}

{name}

Volume Settings

curl --request PATCH \
  --url https://{host}/api/volumes/{owner}/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "allow_download": true,
  "allow_preview": true,
  "watermark": true,
  "watermark_text": "<string>"
}
'

import requests

url = "https://{host}/api/volumes/{owner}/{name}"

payload = {
    "description": "<string>",
    "allow_download": True,
    "allow_preview": True,
    "watermark": True,
    "watermark_text": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    allow_download: true,
    allow_preview: true,
    watermark: true,
    watermark_text: '<string>'
  })
};

fetch('https://{host}/api/volumes/{owner}/{name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/volumes/{owner}/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'allow_download' => true,
    'allow_preview' => true,
    'watermark' => true,
    'watermark_text' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/volumes/{owner}/{name}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"allow_download\": true,\n  \"allow_preview\": true,\n  \"watermark\": true,\n  \"watermark_text\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{host}/api/volumes/{owner}/{name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"allow_download\": true,\n  \"allow_preview\": true,\n  \"watermark\": true,\n  \"watermark_text\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/volumes/{owner}/{name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"allow_download\": true,\n  \"allow_preview\": true,\n  \"watermark\": true,\n  \"watermark_text\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

授权

Authorization

string

header

必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

路径参数

owner

string

必填

name

string

必填

请求体

application/json

visibility

enum<string> | null

可用选项:

private,

public

description

string | null

allow_download

boolean | null

allow_preview

boolean | null

watermark

boolean | null

watermark_text

string | null

响应

Successful Response

开始

接口

Volume Settings

授权

路径参数

请求体

响应