List Locations - Byteport

GET

locations

curl https://api.byteport.com/v1/locations \
  -H "Authorization: Bearer $BYTEPORT_API_KEY" \
  -H "User-Agent: my-app/1.0"

const res = await fetch("https://api.byteport.com/v1/locations", {
  headers: {
    Authorization: `Bearer ${process.env.BYTEPORT_API_KEY}`,
    "User-Agent": "my-app/1.0",
  },
});
const locations = await res.json(); // an array

import os, requests

locations = requests.get(
    "https://api.byteport.com/v1/locations",
    headers={
        "Authorization": f"Bearer {os.environ['BYTEPORT_API_KEY']}",
        "User-Agent": "my-app/1.0",
    },
).json()  # a list

[
  {
    "id":         "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83",
    "provider":   "s3",
    "label":      "prod-backups",
    "status":     "active",
    "created_at": "2026-05-14T17:02:11Z"
  },
  {
    "id":               "8c2e1f4a-9b3d-4e6f-a1c7-2d5b0e9f7a34",
    "provider":         "dropbox",
    "label":            "marketing-assets",
    "status":           "needs_attention",
    "validation_error": "refresh failed repeatedly",
    "created_at":       "2026-04-02T09:18:44Z"
  }
]

List every location in the authenticated workspace. Each item is a non-secret summary — including the lifecycle status, so you can spot locations that have failed or need attention. The response is a JSON array (not an object), takes no request body, and never returns raw secrets.

curl https://api.byteport.com/v1/locations \
  -H "Authorization: Bearer $BYTEPORT_API_KEY" \
  -H "User-Agent: my-app/1.0"

const res = await fetch("https://api.byteport.com/v1/locations", {
  headers: {
    Authorization: `Bearer ${process.env.BYTEPORT_API_KEY}`,
    "User-Agent": "my-app/1.0",
  },
});
const locations = await res.json(); // an array

import os, requests

locations = requests.get(
    "https://api.byteport.com/v1/locations",
    headers={
        "Authorization": f"Bearer {os.environ['BYTEPORT_API_KEY']}",
        "User-Agent": "my-app/1.0",
    },
).json()  # a list

[
  {
    "id":         "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83",
    "provider":   "s3",
    "label":      "prod-backups",
    "status":     "active",
    "created_at": "2026-05-14T17:02:11Z"
  },
  {
    "id":               "8c2e1f4a-9b3d-4e6f-a1c7-2d5b0e9f7a34",
    "provider":         "dropbox",
    "label":            "marketing-assets",
    "status":           "needs_attention",
    "validation_error": "refresh failed repeatedly",
    "created_at":       "2026-04-02T09:18:44Z"
  }
]

Authorizations

Authorization

string

header

required

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

Response

The workspace's locations.

string

Unique identifier for the location (a UUID).

Example:

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

provider

string

The storage backend this location authenticates against.

Example:

"s3"

label

string

The human-readable name. Not unique across an account.

Example:

"prod-backups"

status

enum<string>

Lifecycle state. active is healthy; failed is a provider's terminal rejection (e.g. an invalid grant); needs_attention is Byteport's back-off after repeated refresh failures, awaiting an operator.

Available options:

active,

failed,

needs_attention

Example:

"active"

validation_error

string

Why the location was marked failed. Omitted for active locations.

Example:

"invalid_grant"

created_at

string<date-time>

When the location was created (RFC 3339, UTC).

Example:

"2026-05-14T17:02:11Z"

Create Location

Get Location

curl https://api.byteport.com/v1/locations \
  -H "Authorization: Bearer $BYTEPORT_API_KEY" \
  -H "User-Agent: my-app/1.0"

const res = await fetch("https://api.byteport.com/v1/locations", {
  headers: {
    Authorization: `Bearer ${process.env.BYTEPORT_API_KEY}`,
    "User-Agent": "my-app/1.0",
  },
});
const locations = await res.json(); // an array

import os, requests

locations = requests.get(
    "https://api.byteport.com/v1/locations",
    headers={
        "Authorization": f"Bearer {os.environ['BYTEPORT_API_KEY']}",
        "User-Agent": "my-app/1.0",
    },
).json()  # a list

[
  {
    "id":         "3f9a2b7c-1d4e-4a8f-9c2b-6e5d0a1f7b83",
    "provider":   "s3",
    "label":      "prod-backups",
    "status":     "active",
    "created_at": "2026-05-14T17:02:11Z"
  },
  {
    "id":               "8c2e1f4a-9b3d-4e6f-a1c7-2d5b0e9f7a34",
    "provider":         "dropbox",
    "label":            "marketing-assets",
    "status":           "needs_attention",
    "validation_error": "refresh failed repeatedly",
    "created_at":       "2026-04-02T09:18:44Z"
  }
]