Blob S3 Credentials

GET

credentials

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/s3/credentials' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "access_key_id": "SQ2_3155597145698959364_k7Hq2mX9",
    "secret_access_key": "vR8nLq2Wz5Tc1Yb7Hs0Kd4Jf6Gm3Pa9Xe",
    "endpoint": "https://s3-blob.squarecloud.app",
    "region": "auto",
    "buckets": ["public", "private", "legacy"],
    "access": { "read": true, "write": true },
    "expires_at": null
  }
}

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

S3 Credentials renvoie la paire de clés d’accès que les outils S3 utilisent pour signer les requêtes vers la passerelle S3. La paire est dérivée de la clé API qui appelle cette route : un nouvel appel renvoie la même paire, et révoquer, régénérer ou laisser expirer la clé fait de même pour la paire. Il n’y a rien d’autre à renouveler ni à révoquer. Appelez-la avec une clé API qui possède blob:read ou blob:write. La paire peut lire avec blob:read et écrire avec blob:write, comme l’indique le champ access.

La secret_access_key donne le même accès que la clé API. Conservez-la comme la clé elle-même.

La paire ne change pas tant que la clé API ne change pas. Récupérez-la une fois et conservez-la dans votre gestionnaire de secrets ou dans une variable d’environnement : n’appelez pas cette route à chaque démarrage de votre application.

Limites de débit

10 requêtes par heure par compte (RATE_LIMITED, 429).

Réponse

string

“success” en cas de succès, “error” sinon.

object

Afficher Afficher l'objet

string

L’identifiant de la clé d’accès (SQ2_...).

string

La clé d’accès secrète.

string

https://s3-blob.squarecloud.app

string

auto

string[]

Les buckets de votre compte : public, private et legacy.

object

read et write, chacun valant true ou false, selon les scopes de la clé.

ISO 8601 | null

Date d’expiration de la clé API, et donc de la paire. null si elle n’expire pas.

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/s3/credentials' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "access_key_id": "SQ2_3155597145698959364_k7Hq2mX9",
    "secret_access_key": "vR8nLq2Wz5Tc1Yb7Hs0Kd4Jf6Gm3Pa9Xe",
    "endpoint": "https://s3-blob.squarecloud.app",
    "region": "auto",
    "buckets": ["public", "private", "legacy"],
    "access": { "read": true, "write": true },
    "expires_at": null
  }
}

Erreurs

Code	HTTP	Quand
`API_KEY_REQUIRED`	400	Appel effectué avec une session du tableau de bord. Utilisez une clé API.
`LEGACY_API_KEY`	400	La clé utilise un ancien format qui ne peut pas signer les requêtes S3. Créez une nouvelle clé API.
`INVALID_CREDENTIAL`	401	La clé API n’a pas pu être vérifiée.
`MISSING_SCOPE`	403	La clé ne possède ni `blob:read` ni `blob:write`.
`RATE_LIMITED`	429	Plus de 10 requêtes en une heure.

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/s3/credentials' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "access_key_id": "SQ2_3155597145698959364_k7Hq2mX9",
    "secret_access_key": "vR8nLq2Wz5Tc1Yb7Hs0Kd4Jf6Gm3Pa9Xe",
    "endpoint": "https://s3-blob.squarecloud.app",
    "region": "auto",
    "buckets": ["public", "private", "legacy"],
    "access": { "read": true, "write": true },
    "expires_at": null
  }
}

Premiers Pas

Objets

Upload par Morceaux

Compte

Liens de Partage

S3

Limites de débit

Réponse

Erreurs

​Limites de débit

​Réponse

​Erreurs

Limites de débit

Réponse

Erreurs