Rename a storage link

PATCH

/teams/{teamId}/storage-links/{storageLinkId}

curl --request PATCH \
  --url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/storage-links/a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "EU markets" }'

• This deployment of the Blotout platform API.

Renames a configuration. A name the team already uses fails with name_taken; nothing else about the configuration changes.

Required permissions

• team:manage_storage_links:write on the team

Authorizations

• QintoAccessToken

Parameters

Path Parameters

teamId

required

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

string format: uuid

Example

7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

storageLinkId

required

Unique id (UUID) of the storage link configuration.

string format: uuid

Example

a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

Unique id (UUID) of the storage link configuration.

Request Body^required

The new name.

Media typeapplication/json

object

name

required

Name of the configuration, unique within the team, up to 100 characters.

string

>= 1 characters <= 100 characters

Example

EU markets

Responses

200

The stored name.

Media typeapplication/json

object

storageLinkId

required

Id of the configuration.

string

name

required

The stored name.

string

Example

{
  "storageLinkId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "name": "EU markets"
}

400

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter. invalid_body — The JSON body is unparseable or failed schema validation; details pinpoints the offending fields when the body could be parsed.

Media typeapplication/json

object

error

required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string

Allowed values: invalid_params invalid_body

details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object

key

additional properties

Example

{
  "error": "invalid_params",
  "details": {
    "errors": [],
    "properties": {
      "teamId": {
        "errors": [
          "Invalid UUID"
        ]
      }
    }
  }
}

401

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json

object

error

required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string

Allowed values: unauthenticated

Example

{
  "error": "unauthenticated"
}

403

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.

Media typeapplication/json

object

error

required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string

Allowed values: forbidden

message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
  "error": "forbidden",
  "message": "The Cloudflare API token is invalid or expired."
}

404

not_found — The addressed resource does not exist within this team; check the id and retry.

Media typeapplication/json

object

error

required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string

Allowed values: not_found

Example

{
  "error": "not_found"
}

409

name_taken — The team already has a storage link configuration with this name; choose another.

Media typeapplication/json

object

error

required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string

Allowed values: name_taken

Example

{
  "error": "name_taken"
}

500

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json

object

error

required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string

Allowed values: internal

Example

{
  "error": "internal"
}