Remove one sample set

DELETE

/api/v1/samples/{name}

const url = 'http://localhost:11044/api/v1/samples/example';
const options = {method: 'DELETE', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url http://localhost:11044/api/v1/samples/example \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Every node that set loaded, and nothing else.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

name

required

string

Name of a loaded sample set, as listed by GET /samples, matched exactly; every sample node of the current user that this set loaded is deleted along with its edges. An unknown name removes nothing and still answers 200 with a count of 0

Responses

200

*/*

One sample set removed, and how much went with it

object

nodes

required

How many nodes that set had loaded. Zero means the name matched nothing

integer format: int32

removed

required

The set that was removed, echoed back unchanged

string