Update Location Label

PATCH

locations

curl -X PATCH 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",
    "label": "prod-backups-archive"
  }'

const res = await fetch("https://api.byteport.com/v1/locations", {
  method: "PATCH",
  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: "..."
    label: "prod-backups-archive",
  }),
});
const location = await res.json();

import os, requests

location = requests.patch(
    "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": "..."
        "label": "prod-backups-archive",
    },
).json()

{
  "id":       "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83",
  "provider": "s3",
  "label":    "prod-backups-archive",
  "metadata": { "region": "us-east-1" }
}

{
  "error": 400,
  "message": "label is required"
}

Rename a location — change its label without touching the secret. The provider and secret are unchanged, so renaming never interrupts anything authenticating with the location. A successful update returns the refreshed non-secret projection. label is required and must be non-empty. Address the location to rename by name or id in the same body as the new label. A non-unique name returns 409 with the candidates — resend with the id of the one you want.

curl -X PATCH 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",
    "label": "prod-backups-archive"
  }'

const res = await fetch("https://api.byteport.com/v1/locations", {
  method: "PATCH",
  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: "..."
    label: "prod-backups-archive",
  }),
});
const location = await res.json();

import os, requests

location = requests.patch(
    "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": "..."
        "label": "prod-backups-archive",
    },
).json()

{
  "id":       "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83",
  "provider": "s3",
  "label":    "prod-backups-archive",
  "metadata": { "region": "us-east-1" }
}

{
  "error": 400,
  "message": "label is required"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Address the location by name or id, plus the new label.

label

string

required

The new label. Required and non-empty.

Example:

"prod-backups-archive"

name

string

The location name (its label). Resolved to a single location; if the name matches several, also send id to pick one.

Example:

"prod-backups"

string

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

Label updated.

The non-secret projection of a location (a stored credential). Returned by Create, Get, Replace, and Update Label. Never includes the secret material — only the fields safe to display.

string

Unique identifier for the location (a UUID). Address a location by this id, or by its name (label).

Example:

"3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83"

provider

enum<string>

The storage backend this location authenticates against, set at creation and immutable thereafter.

Available options:

s3,

r2,

wasabi,

b2,

gcs,

azureblob,

dropbox,

drive,

onedrive,

box

Example:

"s3"

label

string

The human-readable name for the location. Labels are not unique: an account may reuse one across providers, and the same name can match several locations — pass an id to disambiguate. Set at creation and changed via Update Label.

Example:

"prod-backups"

metadata

object

Non-secret, provider-specific configuration stored alongside the secret (e.g. region, scopes, account_email). Byteport may stamp additional display hints here. Omitted entirely when empty.

Example:

{ "region": "us-east-1" }

Replace Location Secret

Refresh Location

curl -X PATCH 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",
    "label": "prod-backups-archive"
  }'

const res = await fetch("https://api.byteport.com/v1/locations", {
  method: "PATCH",
  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: "..."
    label: "prod-backups-archive",
  }),
});
const location = await res.json();

import os, requests

location = requests.patch(
    "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": "..."
        "label": "prod-backups-archive",
    },
).json()

{
  "id":       "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83",
  "provider": "s3",
  "label":    "prod-backups-archive",
  "metadata": { "region": "us-east-1" }
}

{
  "error": 400,
  "message": "label is required"
}