Update a storage destination

PATCH

/api/admin/storage-destinations/{id}

Code sample: Shell / cURL

curl --request PATCH \
  --url https://auth.example.com/api/admin/storage-destinations/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "Audit Archive", "description": "Archive bucket", "config": { "bindingRef": "AUDIT_ARCHIVE" }, "status": "active" }'

Update display metadata, provider config, or status for an accessible storage destination.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Request Body ^required

Update a storage destination.

Media type application/json

object

display_name

string

description

Any of:

string

string

null

null

config

object

key

additional properties

status

string

Example

{
  "display_name": "Audit Archive",
  "description": "Archive bucket",
  "config": {
    "bindingRef": "AUDIT_ARCHIVE"
  },
  "status": "active"
}

Responses

200

Storage destination mutation result.

Media type application/json

object

item

required

object

key

additional properties

audit_id

One of:

string

string

null

null

version

integer

key

additional properties

Example

{
  "item": {
    "id": "sd_123",
    "scope_type": "platform",
    "scope_id": "platform",
    "name": "audit-archive",
    "display_name": "Audit Archive",
    "description": "R2 bucket for audit log archives.",
    "provider": "r2",
    "config": {
      "bindingRef": "AUDIT_ARCHIVE"
    },
    "managed_by": "admin",
    "read_only": false,
    "has_credential": false,
    "credential_key_version": null,
    "credential_updated_at": null,
    "credential_updated_by": null,
    "status": "active",
    "created_by": "admin_123",
    "updated_by": "admin_123",
    "created_at": 1770000000000,
    "updated_at": 1770000000000
  },
  "audit_id": "audit_123"
}

default

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}