Get Storage Credentials

curl --request POST \
  --url https://api.cloud.wherobots.com/storage/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>"
}
'

import requests

url = "https://api.cloud.wherobots.com/storage/credentials"

payload = { "path": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<string>'})
};

fetch('https://api.cloud.wherobots.com/storage/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloud.wherobots.com/storage/credentials"

	payload := strings.NewReader("{\n  \"path\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cloud.wherobots.com/storage/credentials")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\"\n}")
  .asString();

{
  "accessKeyId": "<string>",
  "secretAccessKey": "<string>",
  "sessionToken": "<string>",
  "expiration": "2023-11-07T05:31:56Z",
  "region": "<string>",
  "matchedGrantTarget": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

storage

Get Storage Credentials

Return temporary AWS credentials for an S3 path your organization can reach. access_mode sets whether they can write. With the Minimal privilege, the default, they cover the requested path. With Default, they cover a wider authorized scope returned as matchedGrantTarget, and you may reuse them for paths under it with the same access mode until they expire. An identical request may return the same credentials until they near expiry. IAM restrictions still apply. User files paths are refused.

POST

storage

credentials

curl --request POST \
  --url https://api.cloud.wherobots.com/storage/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>"
}
'

import requests

url = "https://api.cloud.wherobots.com/storage/credentials"

payload = { "path": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<string>'})
};

fetch('https://api.cloud.wherobots.com/storage/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloud.wherobots.com/storage/credentials"

	payload := strings.NewReader("{\n  \"path\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cloud.wherobots.com/storage/credentials")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\"\n}")
  .asString();

{
  "accessKeyId": "<string>",
  "secretAccessKey": "<string>",
  "sessionToken": "<string>",
  "expiration": "2023-11-07T05:31:56Z",
  "region": "<string>",
  "matchedGrantTarget": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>",
      "data": {}
    }
  ],
  "requestId": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for the unified storage credentials endpoint.

path

string

required

S3 URI (e.g. s3://bucket/prefix) to obtain credentials for.

Required string length: 6 - 1024

Pattern: ^s3:\/\/([a-zA-Z0-9._\-]{3,63})(?:\/?|\/([a-zA-Z0-9!_.*'()/&=-]+))?$

access_mode

enum<string>

default:read

Access mode for the credentials. 'read' returns read-only credentials; 'read_write' returns credentials that also allow writing.

Available options:

read,

read_write

privilege

enum<string>

default:Minimal

Minimal preserves requested-path scoping. Default opts into credentials for a server-selected authorized scope, returned as matchedGrantTarget. Underlying IAM restrictions still apply within that scope.

Available options:

Minimal,

Default

duration_seconds

integer

default:3600

Requested credential lifetime in seconds.

Required range: 900 <= x <= 3600

Response

Temporary AWS credentials; OPERA sources use provider-scoped read-only ASF sessions

Credentials with an optional server-selected target for client cache reuse.

accessKeyId

string

required

secretAccessKey

string

required

sessionToken

string

required

expiration

string<date-time>

required

region

string

required

matchedGrantTarget

string | null

Returned for Default privilege when the scope has no competing credential sources. If absent, cache only for the exact request. A trailing slash denotes descendants only; otherwise match the exact path or slash-delimited descendants. Reuse requires the same access mode and unexpired credentials.