Locations
Delete Location
Permanently delete a location.
DELETE
/
v1
/
locations
curl -X DELETE https://api.byteport.com/v1/locations \
-H "Authorization: Bearer $BYTEPORT_API_KEY" \
-H "User-Agent: my-app/1.0" \
-H "Content-Type: application/json" \
-d '{ "id": "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83" }'
await fetch("https://api.byteport.com/v1/locations", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.BYTEPORT_API_KEY}`,
"User-Agent": "my-app/1.0",
"Content-Type": "application/json",
},
body: JSON.stringify({ id: "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83" }), // or { name: "..." }
});
import os, requests
requests.delete(
"https://api.byteport.com/v1/locations",
headers={
"Authorization": f"Bearer {os.environ['BYTEPORT_API_KEY']}",
"User-Agent": "my-app/1.0",
},
json={"id": "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83"}, # or {"name": "..."}
)
(empty body)
{
"error": "name is not unique; re-issue with an \"id\" field for one of the candidates",
"name": "prod-backups",
"candidates": [
{
"id": "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83",
"provider": "s3",
"created_at": "2026-05-14T17:02:11Z",
"updated_at": "2026-06-01T09:44:20Z"
},
{
"id": "8c2e1f4a-9b3d-4e6f-a1c7-2d5b0e9f7a34",
"provider": "gcs",
"created_at": "2026-05-20T11:07:33Z",
"updated_at": "2026-05-20T11:07:33Z"
}
]
}
Permanently delete a location. Deletion is immediate and cannot be undone —
any transfer that resolves to it will stop authenticating. A successful delete
returns
204 No Content.
Address the location by name or id in the request body; at least one
is required. A non-unique name returns 409 with the candidates — resend with
the id of the one you want.
curl -X DELETE https://api.byteport.com/v1/locations \
-H "Authorization: Bearer $BYTEPORT_API_KEY" \
-H "User-Agent: my-app/1.0" \
-H "Content-Type: application/json" \
-d '{ "id": "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83" }'
await fetch("https://api.byteport.com/v1/locations", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.BYTEPORT_API_KEY}`,
"User-Agent": "my-app/1.0",
"Content-Type": "application/json",
},
body: JSON.stringify({ id: "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83" }), // or { name: "..." }
});
import os, requests
requests.delete(
"https://api.byteport.com/v1/locations",
headers={
"Authorization": f"Bearer {os.environ['BYTEPORT_API_KEY']}",
"User-Agent": "my-app/1.0",
},
json={"id": "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83"}, # or {"name": "..."}
)
(empty body)
{
"error": "name is not unique; re-issue with an \"id\" field for one of the candidates",
"name": "prod-backups",
"candidates": [
{
"id": "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83",
"provider": "s3",
"created_at": "2026-05-14T17:02:11Z",
"updated_at": "2026-06-01T09:44:20Z"
},
{
"id": "8c2e1f4a-9b3d-4e6f-a1c7-2d5b0e9f7a34",
"provider": "gcs",
"created_at": "2026-05-20T11:07:33Z",
"updated_at": "2026-05-20T11:07:33Z"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Address the location by name or id.
The location name (its label). Resolved to a single location; if the name matches several, also send id to pick one.
Example:
"prod-backups"
The location's UUID. Addresses one location directly, or — alongside name — selects which match of a non-unique name to act on.
Example:
"3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83"
Response
Location deleted. The response body is empty.
curl -X DELETE https://api.byteport.com/v1/locations \
-H "Authorization: Bearer $BYTEPORT_API_KEY" \
-H "User-Agent: my-app/1.0" \
-H "Content-Type: application/json" \
-d '{ "id": "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83" }'
await fetch("https://api.byteport.com/v1/locations", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.BYTEPORT_API_KEY}`,
"User-Agent": "my-app/1.0",
"Content-Type": "application/json",
},
body: JSON.stringify({ id: "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83" }), // or { name: "..." }
});
import os, requests
requests.delete(
"https://api.byteport.com/v1/locations",
headers={
"Authorization": f"Bearer {os.environ['BYTEPORT_API_KEY']}",
"User-Agent": "my-app/1.0",
},
json={"id": "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83"}, # or {"name": "..."}
)
(empty body)
{
"error": "name is not unique; re-issue with an \"id\" field for one of the candidates",
"name": "prod-backups",
"candidates": [
{
"id": "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83",
"provider": "s3",
"created_at": "2026-05-14T17:02:11Z",
"updated_at": "2026-06-01T09:44:20Z"
},
{
"id": "8c2e1f4a-9b3d-4e6f-a1c7-2d5b0e9f7a34",
"provider": "gcs",
"created_at": "2026-05-20T11:07:33Z",
"updated_at": "2026-05-20T11:07:33Z"
}
]
}