Delete an Object from a Volume

curl --request POST \
  --url https://api.cycls.ai/v1/volume/delete-object \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "volume": "shared-data",
  "path": "models/model.bin"
}
'

import requests

url = "https://api.cycls.ai/v1/volume/delete-object"

payload = {
    "volume": "shared-data",
    "path": "models/model.bin"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({volume: 'shared-data', path: 'models/model.bin'})
};

fetch('https://api.cycls.ai/v1/volume/delete-object', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "detail": "<string>"
}

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

POST

https://api.cycls.ai

volume

delete-object

Delete an Object from a Volume

curl --request POST \
  --url https://api.cycls.ai/v1/volume/delete-object \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "volume": "shared-data",
  "path": "models/model.bin"
}
'

import requests

url = "https://api.cycls.ai/v1/volume/delete-object"

payload = {
    "volume": "shared-data",
    "path": "models/model.bin"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({volume: 'shared-data', path: 'models/model.bin'})
};

fetch('https://api.cycls.ai/v1/volume/delete-object', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "detail": "<string>"
}

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

Authorizations

X-API-Key

string

header

required

Your Cycls API key, from https://cloud.cycls.com. Sent as the X-API-Key header. This is the CYCLS_API_KEY the CLI uses.

Body

application/json

volume

string

required

Volume name

Example:

"shared-data"

path

string

required

Object path within the volume

Example:

"models/model.bin"

Response

Successful Response

detail

string

required

Overview

Endpoints

Delete an Object from a Volume

Authorizations

Body

Response