Platform Integration API Reference CLI Benchmarks

Storages

Get a single storage

Retrieve details of a specific storage configuration by its id.

GET

/api/storages/{storageId}

Authorization

Authorization

header

string

required

Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"

Path Parameters

storageId

string

required

Storage id

Responses

application/json

data

object

required

Data contains the response object

A customer-owned storage connection using the standard S3 API.

status

"success"

string

required

Status indicates the response status "success"

OK

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Authentication error: invalid token or subscription inactive

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Resource not found

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Rate limit exceeded

import Chunkify from '@chunkify/chunkify';

const client = new Chunkify({
  projectAccessToken: 'My Project Access Token',
});

const storage = await client.storages.retrieve('storageId');

console.log(storage);
from chunkify import Chunkify

client = Chunkify(
    project_access_token="My Project Access Token",
)
storage = client.storages.retrieve(
    "storageId",
)
print(storage)
<?php

use Chunkify\Client;

$client = new Client(
    projectAccessToken: 'My Project Access Token',
);

$storage = $client->storages->retrieve('storageId');

var_dump($storage);
package main

import (
  "context"
  "fmt"

  "github.com/chunkifydev/chunkify-go"
  "github.com/chunkifydev/chunkify-go/option"
)

func main() {
  client := chunkify.NewClient(
    option.WithProjectAccessToken("My Project Access Token"),
  )
  storage, err := client.Storages.Get(context.TODO(), "storageId")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", storage)
}

{
  "data": {
    "created_at": "2021-01-01T00:00:00Z",
    "id": "stor_chunkify_S1cce6120E56e7Tu9ioP09Nhjk1",
    "provider": "chunkify",
    "region": "us-east-1",
    "slug": "chunkify-10"
  },
  "status": "success"
}
{
  "error": {
    "code": 401,
    "message": "Authentication error: invalid token or subscription inactive",
    "type": "AuthenticationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 404,
    "message": "Ressource not found",
    "type": "NotFoundError"
  },
  "status": "error"
}
{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded",
    "type": "TooManyRequestsError"
  },
  "status": "error"
}

# Get a single storage > Retrieve details of a specific storage configuration by its id. ```json { "path": "/api/storages/{storageId}", "method": "get", "schema": { "description": "Retrieve details of a specific storage configuration by its id.", "operationId": "getStorage", "parameters": [ { "description": "Storage id", "in": "path", "name": "storageId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageResponse" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorAuthentication" } } }, "description": "Authentication error: invalid token or subscription inactive" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorNotFound" } } }, "description": "Resource not found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorTooManyRequests" } } }, "description": "Rate limit exceeded" } }, "security": [ { "ProjectAccessToken": [] } ], "summary": "Get a single storage", "tags": [ "Storages" ], "x-codeSamples": [ { "lang": "JavaScript", "source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n projectAccessToken: 'My Project Access Token',\n});\n\nconst storage = await client.storages.retrieve('storageId');\n\nconsole.log(storage);" }, { "lang": "Python", "source": "from chunkify import Chunkify\n\nclient = Chunkify(\n project_access_token=\"My Project Access Token\",\n)\nstorage = client.storages.retrieve(\n \"storageId\",\n)\nprint(storage)" }, { "lang": "php", "source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n projectAccessToken: 'My Project Access Token',\n);\n\n$storage = $client-\u003estorages-\u003eretrieve('storageId');\n\nvar_dump($storage);" }, { "lang": "Go", "source": "package main\n\nimport (\n \"context\"\n \"fmt\"\n\n \"github.com/chunkifydev/chunkify-go\"\n \"github.com/chunkifydev/chunkify-go/option\"\n)\n\nfunc main() {\n client := chunkify.NewClient(\n option.WithProjectAccessToken(\"My Project Access Token\"),\n )\n storage, err := client.Storages.Get(context.TODO(), \"storageId\")\n if err != nil {\n panic(err.Error())\n }\n fmt.Printf(\"%+v\\n\", storage)\n}\n" } ] } } ``` ```json #/components/schemas/StorageResponse { "properties": { "data": { "$ref": "#/components/schemas/Storage", "description": "Data contains the response object" }, "status": { "const": "success", "description": "Status indicates the response status \"success\"", "type": "string" } }, "required": [ "status", "data" ], "type": "object" } ``` ```json #/components/schemas/Storage { "discriminator": { "propertyName": "provider" }, "oneOf": [ { "$ref": "#/components/schemas/StorageChunkify" }, { "$ref": "#/components/schemas/StorageCloudflare" }, { "$ref": "#/components/schemas/StorageAws" }, { "$ref": "#/components/schemas/StorageS3Compatible" } ], "type": "object" } ``` ```json #/components/schemas/StorageS3Compatible { "description": "A customer-owned storage connection using the standard S3 API.", "properties": { "addressing_style": { "description": "Addressing style detected during connection validation and used for later S3 operations.", "enum": [ "virtual", "path" ], "type": "string" }, "base_prefix": { "description": "Canonical object-key prefix prepended to every final job output in this customer-owned storage. An empty string means the bucket root.", "examples": [ "chunkify/" ], "maxLength": 768, "type": "string" }, "bucket": { "description": "Bucket is the name of the storage bucket.", "examples": [ "my-bucket" ], "type": "string" }, "cdn_base_url": { "description": "Optional customer-managed HTTPS delivery origin used to build stable CDN URLs for objects in this storage.", "examples": [ "https://media.example.com" ], "format": "uri", "maxLength": 267, "nullable": true, "type": "string" }, "created_at": { "description": "Created at timestamp", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string" }, "endpoint": { "description": "Public HTTPS origin for the S3-compatible service. Credentials, paths, queries, fragments, and non-public destinations are rejected.", "examples": [ "https://s3.us-west-004.backblazeb2.com" ], "format": "uri", "type": "string" }, "id": { "description": "Unique identifier of the storage configuration", "examples": [ "stor_s3_compatible_S1cce6120E56e7Tu9ioP09Nhjk1" ], "type": "string" }, "location": { "$ref": "#/components/schemas/StorageLocation", "description": "Chunkify workload location. This is independent from the provider signing region." }, "provider": { "const": "s3_compatible", "description": "Stable provider identifier for generic S3-compatible storage.", "enum": [ "s3_compatible" ], "type": "string" }, "public": { "description": "Public indicates whether the storage is publicly accessible.", "examples": [ "false" ], "type": "boolean" }, "region": { "description": "Provider region used for S3 request signing. This is independent from the Chunkify workload location.", "examples": [ "us-west-004" ], "type": "string" }, "slug": { "description": "Unique identifier of the storage configuration", "examples": [ "s3_compatible-40" ], "type": "string" } }, "required": [ "id", "slug", "provider", "region", "bucket", "endpoint", "location", "addressing_style", "public", "base_prefix", "created_at" ] } ``` ```json #/components/schemas/StorageLocation { "description": "Location specifies the location of the storage provider.", "enum": [ "US", "EU", "ASIA" ], "examples": [ "US" ], "type": "string" } ``` ```json #/components/schemas/StorageChunkify { "properties": { "created_at": { "description": "Created at timestamp", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the storage configuration", "examples": [ "stor_chunkify_S1cce6120E56e7Tu9ioP09Nhjk1" ], "type": "string" }, "provider": { "const": "chunkify", "description": "Provider specifies the storage provider.", "enum": [ "chunkify" ], "type": "string" }, "region": { "$ref": "#/components/schemas/ChunkifyRegion", "description": "Region specifies the region of the storage provider." }, "slug": { "description": "Unique identifier of the storage configuration", "examples": [ "chunkify-10" ], "type": "string" } }, "required": [ "id", "slug", "provider", "region", "created_at" ] } ``` ```json #/components/schemas/ChunkifyRegion { "description": "Chunkify available regions.", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "eu-west-1", "eu-west-2", "ap-northeast-1", "ap-southeast-1" ], "type": "string" } ``` ```json #/components/schemas/StorageCloudflare { "properties": { "base_prefix": { "description": "Canonical object-key prefix prepended to every final job output in this customer-owned storage. An empty string means the bucket root.", "examples": [ "chunkify/" ], "maxLength": 768, "type": "string" }, "bucket": { "description": "Bucket is the name of the storage bucket.", "examples": [ "my-bucket" ], "type": "string" }, "cdn_base_url": { "description": "Optional customer-managed HTTPS delivery origin used to build stable CDN URLs for objects in this storage.", "examples": [ "https://media.example.com" ], "format": "uri", "maxLength": 267, "nullable": true, "type": "string" }, "created_at": { "description": "Created at timestamp", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string" }, "endpoint": { "description": "Endpoint is the endpoint of the storage provider.", "examples": [ "https://[id].r2.cloudflarestorage.com" ], "format": "uri", "pattern": "^https://[a-z0-9]{32}\\.r2\\.cloudflarestorage\\.com$", "type": "string" }, "id": { "description": "Unique identifier of the storage configuration", "examples": [ "stor_cloudflare_S1cce6120E56e7Tu9ioP09Nhjk1" ], "type": "string" }, "location": { "$ref": "#/components/schemas/StorageLocation", "description": "Location specifies the location of the storage provider." }, "provider": { "const": "cloudflare", "description": "Provider specifies the storage provider.", "enum": [ "cloudflare" ], "type": "string" }, "public": { "default": false, "description": "Public indicates whether the storage is publicly accessible.", "examples": [ "false" ], "type": "boolean" }, "region": { "const": "auto", "description": "Region specifies the region of the storage provider.", "enum": [ "auto" ], "type": "string" }, "slug": { "description": "Unique identifier of the storage configuration", "examples": [ "cloudflare-20" ], "type": "string" } }, "required": [ "id", "slug", "provider", "region", "bucket", "endpoint", "location", "public", "base_prefix", "created_at" ] } ``` ```json #/components/schemas/StorageLocation { "description": "Location specifies the location of the storage provider.", "enum": [ "US", "EU", "ASIA" ], "examples": [ "US" ], "type": "string" } ``` ```json #/components/schemas/StorageAws { "properties": { "base_prefix": { "description": "Canonical object-key prefix prepended to every final job output in this customer-owned storage. An empty string means the bucket root.", "examples": [ "chunkify/" ], "maxLength": 768, "type": "string" }, "bucket": { "description": "Bucket is the name of the storage bucket.", "examples": [ "my-bucket" ], "type": "string" }, "cdn_base_url": { "description": "Optional customer-managed HTTPS delivery origin used to build stable CDN URLs for objects in this storage.", "examples": [ "https://media.example.com" ], "format": "uri", "maxLength": 267, "nullable": true, "type": "string" }, "created_at": { "description": "Created at timestamp", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the storage configuration", "examples": [ "stor_aws_S1cce6120E56e7Tu9ioP09Nhjk1" ], "type": "string" }, "provider": { "const": "aws", "description": "Provider specifies the storage provider.", "enum": [ "aws" ], "type": "string" }, "public": { "default": false, "description": "Public indicates whether the storage is publicly accessible.", "examples": [ "false" ], "type": "boolean" }, "region": { "$ref": "#/components/schemas/AwsRegion", "description": "Region specifies the region of the storage provider." }, "slug": { "description": "Unique identifier of the storage configuration", "examples": [ "aws-30" ], "type": "string" } }, "required": [ "id", "slug", "provider", "region", "bucket", "public", "base_prefix", "created_at" ] } ``` ```json #/components/schemas/AwsRegion { "description": "Region specifies the region of the storage provider.", "enum": [ "us-east-1", "us-east-2", "us-central-1", "us-west-1", "us-west-2", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "eu-north-1", "ap-east-1", "ap-east-2", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2" ], "examples": [ "us-east-1" ], "type": "string" } ``` ```json #/components/schemas/ResponseErrorAuthentication { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 401, "description": "Code is the HTTP status code", "examples": [ 401 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Authentication error: invalid token or subscription inactive" ], "type": "string" }, "type": { "const": "AuthenticationError", "description": "Type indicates the error category", "enum": [ "AuthenticationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorNotFound { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 404, "description": "Code is the HTTP status code", "examples": [ 404 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Ressource not found" ], "type": "string" }, "type": { "const": "NotFoundError", "description": "Type indicates the error category", "enum": [ "NotFoundError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorTooManyRequests { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 429, "description": "Code is the HTTP status code", "examples": [ 429 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Rate limit exceeded" ], "type": "string" }, "type": { "const": "TooManyRequestsError", "description": "Type indicates the error category", "enum": [ "TooManyRequestsError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ```