Get File url by ID
GETDescription: Retrieve a file URL for a specified ID. The generated URL automatically downloads the file. If you haven't generated a file yet, use the appropriate endpoint to do so./storage/files/:id/url
Request
Path Parameters
id stringrequired
File ID.
Header Parameters
nonce stringrequired
The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.
x-lang string
Possible values: [pt-BR
, en-US
]
Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.
x-product-uuid string
The product ID is a UUID (v4) used to identify the Z.ro product configuration.
x-product-target-user-uuid string
The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.
Responses
- 200
- 400
- 401
- 422
File URL returned successfully.
- application/json
- Schema
- Example (from schema)
Schema
url stringrequired
URL File.
size numberrequired
Size File. This format is is byte. Ex: 307504 Byte => 300 KB => 0,3 MB
{
"url": "https://s3.amazonaws.com/bucket/folder/file.csv",
"size": 307504
}
If any required params are missing or has invalid format or type.
User authentication failed.
If any required params are missing or has invalid format or type.
Authorization: http
name: bearertype: httpscheme: bearerbearerFormat: JWT
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://docs.zrobank.io/storage/files/:id/url' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
ResponseClear