Skip to content

fix storage s3 protocol code on docs page #1954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 6, 2025
Merged

fix storage s3 protocol code on docs page #1954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 32 additions & 27 deletions src/content/docs/en/pages/store-journey/storage/use-s3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,21 @@ The S3 protocol allows you to access buckets and objects using an Object Storage
1. Run the following `POST` request in your terminal, replacing `[TOKEN VALUE]` with your [personal token](/en/documentation/products/guides/personal-tokens/):

```bash
curl --location 'https://api.azion.com/v4#/operations/PostEdgeStorageCredentials' \
--header 'Accept: application/json' \
--header 'Authorization: Token [TOKEN VALUE]' \
--header 'Content-Type: application/json' \
--data '{
"name": "my-s3-credential",
"capabilities": [
curl --request POST \
--url https://api.azion.com/v4/workspace/storage/credentials \
--header 'Accept: application/json' \
--header 'Authorization: Token [TOKEN VALUE]' \
--header 'Content-Type: application/json' \
--data '{
"name": "full-access",
"capabilities": [
"listAllBucketNames",
"listBuckets",
"listFiles",
"readFiles",
"writeFiles",
"deleteFiles"
],
"bucket": "<bucket_name>",
"expiration_date": "<datetime>"
]
}'
```

Expand All @@ -53,26 +52,32 @@ curl --location 'https://api.azion.com/v4#/operations/PostEdgeStorageCredentials

```json
{
"state": "executed",
"data": {
"name": "my-s3-credential",
"access_key": "<s3_credential_access_key>",
"secret_key": "<s3_credential_secret_key>", // this value can no longer be accessed in future requests
"capabilities": [
"listAllBucketNames",
"listBuckets",
"listFiles",
"readFiles",
"writeFiles",
"deleteFiles"
],
"bucket": "<bucket_name>",
"expiration_date": "<datetime>",
"created_at": "<datetime>"
}
"state": "executed",
"data": {
"name": "full-access",
"access_key": "<s3_credential_access_key>",
"secret_key": "<s3_credential_secret_key>", // this value can no longer be accessed in future requests
,
"capabilities": [
"listAllBucketNames",
"listBuckets",
"listFiles",
"readFiles",
"writeFiles",
"deleteFiles"
],
"bucket": null,
"expiration_date": null,
"last_editor": "editor@email.com",
"last_modified": "2025-11-05T19:55:31.542240Z"
}
}
```

:::note
The bucket field is optional. If it is not provided and the credential has the capabilities listAllBucketNames and listBuckets, it can be used to access all buckets in the account. However, if the bucket field is specified, access will be restricted to the indicated bucket.
:::

3. Copy the values of the `access_key` and `secret_key` to set up access thorugh the S3 protocol.

---
Expand Down
59 changes: 32 additions & 27 deletions src/content/docs/pt-br/pages/store-jornada/storage/usar-s3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,21 @@ O protocolo S3 permite que você acesse buckets e objetos usando uma URL do Obje
1. Execute a seguinte requisição `POST` no seu terminal, substituindo `[TOKEN VALUE]` pelo seu [personal token](/pt-br/documentacao/produtos/guias/personal-tokens/):

```bash
curl --location 'https://api.azion.com/v4#/operations/PostEdgeStorageCredentials' \
--header 'Accept: application/json' \
--header 'Authorization: Token [TOKEN VALUE]' \
--header 'Content-Type: application/json' \
--data '{
"name": "my-s3-credential",
"capabilities": [
curl --request POST \
--url https://api.azion.com/v4/workspace/storage/credentials \
--header 'Accept: application/json' \
--header 'Authorization: Token [TOKEN VALUE]' \
--header 'Content-Type: application/json' \
--data '{
"name": "full-access",
"capabilities": [
"listAllBucketNames",
"listBuckets",
"listFiles",
"readFiles",
"writeFiles",
"deleteFiles"
],
"bucket": "<bucket_name>",
"expiration_date": "<datetime>"
]
}'
```

Expand All @@ -51,26 +50,32 @@ curl --location 'https://api.azion.com/v4#/operations/PostEdgeStorageCredentials

```json
{
"state": "executed",
"data": {
"name": "my-s3-credential",
"access_key": "<s3_credential_access_key>",
"secret_key": "<s3_credential_secret_key>", // this value can no longer be accessed in future requests
"capabilities": [
"listAllBucketNames",
"listBuckets",
"listFiles",
"readFiles",
"writeFiles",
"deleteFiles"
],
"bucket": "<bucket_name>",
"expiration_date": "<datetime>",
"created_at": "<datetime>"
}
"state": "executed",
"data": {
"name": "full-access",
"access_key": "<s3_credential_access_key>",
"secret_key": "<s3_credential_secret_key>", // this value can no longer be accessed in future requests
,
"capabilities": [
"listAllBucketNames",
"listBuckets",
"listFiles",
"readFiles",
"writeFiles",
"deleteFiles"
],
"bucket": null,
"expiration_date": null,
"last_editor": "gabriel.bullit@gmail.com",
"last_modified": "2025-11-05T19:55:31.542240Z"
}
}
```

:::note
O campo bucket é opcional. Caso não seja informado e a credencial possua as capacidades listAllBucketNames e listBuckets, ela poderá ser utilizada para acessar todos os buckets da conta. No entanto, se o campo bucket for especificado, o acesso será restrito apenas ao bucket indicado.
:::

3. Copie os valores de `access_key` e `secret_key` para configurar o acesso através do protocolo S3.

---
Expand Down