Hubfly spaceDocs
Console

Storage API · Dashboard

Buckets, keys & objects

Provision project storage, manage S3 keys and buckets, and create direct object upload or download sessions.

Base URL: https://api.hubfly.space. Use a Dashboard bearer token authorized for the project. Replace :projectId in each path with the Dashboard project ID. JSON routes use Content-Type: application/json.

How to use these endpoints

  1. Read the project overview and quota before creating data.
  2. Create a bucket and a narrowly scoped access key. The secret appears only in the create response.
  3. For browser uploads, request an upload session and send the bytes to the returned URL. For server workloads, use the S3 endpoint directly.
  4. List or download the object after upload; remove objects before deleting their bucket.

Create a bucket

curl
curl -X POST "https://api.hubfly.space/api/v1/projects/$PROJECT_ID/storage/buckets/create" \
  -H "Authorization: Bearer $HUBFLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"project-assets"}'

The response uses the standard Dashboard envelope: ok, data, and meta on success. On failure, use the returned error code and message to decide whether to correct the request or retry. The exact schema and response codes for each operation are below.

Endpoint reference

Dashboard endpoints (16)

These JSON routes are served by the Hubfly space Dashboard API and use Dashboard project authorization.

Open interactive API explorer
POSTCreate an S3 access keyDetails +/api/v1/projects/:projectId/storage/access-keys/create

Creates an access and secret key for S3-compatible requests, scoped to read-only or read/write access and optionally to one bucket.

  • The secret key is returned at creation. Store it securely; the list endpoint never returns it again.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—

JSON request body

FieldType / allowed valuesRequired
namestringYes
permissionread | readwriteYes
bucketScopestringNo
Complete request schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "permission": {
      "type": "string",
      "enum": [
        "read",
        "readwrite"
      ]
    },
    "bucketScope": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "permission"
  ],
  "additionalProperties": false
}
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "access_key": {
              "type": "string"
            },
            "secret_key": {
              "type": "string"
            },
            "tenant_id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "permission": {
              "type": "string",
              "enum": [
                "read",
                "readwrite"
              ]
            },
            "bucket_scope": {
              "type": "string"
            }
          },
          "required": [
            "access_key",
            "secret_key",
            "tenant_id",
            "name",
            "permission"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "access_key": "string",
        "secret_key": "string",
        "tenant_id": "string",
        "name": "string",
        "permission": "read",
        "bucket_scope": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETList S3 access keysDetails +/api/v1/projects/:projectId/storage/access-keys

Lists project keys with names, permissions, bucket scope and lifecycle metadata without exposing secret keys.

  • Use the returned access-key ID with the revoke endpoint to remove access.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "access_key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "permission": {
                "type": "string",
                "enum": [
                  "read",
                  "readwrite"
                ]
              },
              "bucket_scope": {
                "type": "string"
              },
              "created_at": {
                "type": "string"
              },
              "last_used_at": {
                "type": "string"
              },
              "revoked_at": {
                "type": "string"
              }
            },
            "required": [
              "access_key",
              "name",
              "permission",
              "created_at"
            ],
            "additionalProperties": false
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": [
        {
          "access_key": "string",
          "name": "string",
          "permission": "read",
          "bucket_scope": "string",
          "created_at": "string",
          "last_used_at": "string",
          "revoked_at": "string"
        }
      ],
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
DELETERevoke an S3 access keyDetails +/api/v1/projects/:projectId/storage/access-keys/revoke

Revokes the access key identified by the accessKey query parameter.

  • Revocation blocks future SigV4 requests using the key.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
accessKeyqueryYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "ok": {
              "type": "boolean"
            }
          },
          "required": [
            "ok"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "ok": true
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
POSTCreate a storage API keyDetails +/api/v1/projects/:projectId/storage/api-keys/create

Create an hfs_ API key for uploads to this storage project, optionally limited to one existing bucketName and set to expire after expiresInDays. The full key is returned only in this response.

  • Requires the storage:admin project permission on a storage project.
  • The key is shown once; send it as Authorization: Bearer hfs_…. It only authorizes the storage object and media upload-session endpoints.
  • name is 2–64 letters, numbers, spaces, dots, underscores or hyphens; expiresInDays is 1–365 (omit for no expiry).
  • Up to 20 active keys per project (400 STORAGE_KEY_LIMIT); an unknown bucket returns 400 STORAGE_KEY_BUCKET_NOT_FOUND.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—

JSON request body

FieldType / allowed valuesRequired
namestringYes
bucketNamestringNo
expiresInDaysnumberNo
Complete request schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "bucketName": {
      "type": "string"
    },
    "expiresInDays": {
      "type": "number"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "tokenPrefix": {
              "type": "string"
            },
            "bucketName": {
              "type": "string",
              "nullable": true
            },
            "createdAt": {
              "type": "string"
            },
            "lastUsedAt": {
              "type": "string",
              "nullable": true
            },
            "expiresAt": {
              "type": "string",
              "nullable": true
            },
            "expired": {
              "type": "boolean"
            },
            "revokedAt": {
              "type": "string",
              "nullable": true
            },
            "key": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name",
            "tokenPrefix",
            "bucketName",
            "createdAt",
            "lastUsedAt",
            "expiresAt",
            "expired",
            "revokedAt",
            "key"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "id": "string",
        "name": "string",
        "tokenPrefix": "string",
        "bucketName": "string",
        "createdAt": "string",
        "lastUsedAt": "string",
        "expiresAt": "string",
        "expired": true,
        "revokedAt": "string",
        "key": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETList storage API keysDetails +/api/v1/projects/:projectId/storage/api-keys

List the storage project's API keys, newest first, with name, token prefix, bucket scope, creation, last use, expiry, expired and revocation time. Key values are never returned.

  • Requires the storage:admin project permission on a storage project.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "tokenPrefix": {
                "type": "string"
              },
              "bucketName": {
                "type": "string",
                "nullable": true
              },
              "createdAt": {
                "type": "string"
              },
              "lastUsedAt": {
                "type": "string",
                "nullable": true
              },
              "expiresAt": {
                "type": "string",
                "nullable": true
              },
              "expired": {
                "type": "boolean"
              },
              "revokedAt": {
                "type": "string",
                "nullable": true
              }
            },
            "required": [
              "id",
              "name",
              "tokenPrefix",
              "bucketName",
              "createdAt",
              "lastUsedAt",
              "expiresAt",
              "expired",
              "revokedAt"
            ],
            "additionalProperties": false
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": [
        {
          "id": "string",
          "name": "string",
          "tokenPrefix": "string",
          "bucketName": "string",
          "createdAt": "string",
          "lastUsedAt": "string",
          "expiresAt": "string",
          "expired": true,
          "revokedAt": "string"
        }
      ],
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
DELETERevoke a storage API keyDetails +/api/v1/projects/:projectId/storage/api-keys/revoke

Revoke one storage API key by keyId; requests using it are refused from then on. Any storage admin of the project can revoke any key.

  • Requires the storage:admin project permission on a storage project.
  • An unknown or already revoked key returns 404 STORAGE_KEY_NOT_FOUND.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
keyIdqueryYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "ok": {
              "type": "boolean"
            }
          },
          "required": [
            "ok"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "ok": true
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
POSTCreate a storage bucketDetails +/api/v1/projects/:projectId/storage/buckets/create

Creates a bucket inside the project storage tenant. Bucket names must follow S3 naming rules and be unique within the tenant.

  • Buckets are created through the Dashboard; clients then use the region’s S3 endpoint with a scoped key.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—

JSON request body

FieldType / allowed valuesRequired
namestringYes
Complete request schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "tenant_id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "versioning": {
              "type": "string"
            },
            "image_retention_seconds": {
              "type": "number"
            },
            "created_at": {
              "type": "string"
            },
            "deleted_at": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "tenant_id",
            "name",
            "versioning",
            "image_retention_seconds",
            "created_at"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "id": "string",
        "tenant_id": "string",
        "name": "string",
        "versioning": "string",
        "image_retention_seconds": 0,
        "created_at": "string",
        "deleted_at": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
DELETEDelete a storage bucketDetails +/api/v1/projects/:projectId/storage/buckets/delete

Deletes the bucket named by the name query parameter.

  • The bucket must satisfy the service’s deletion requirements. Back up required objects before deleting.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
namequeryYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "ok": {
              "type": "boolean"
            }
          },
          "required": [
            "ok"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "ok": true
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETList project bucketsDetails +/api/v1/projects/:projectId/storage/buckets

Returns the project’s buckets and settings, including versioning and image retention.

  • Use the bucket object-list endpoint to enumerate contents.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "tenant_id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "versioning": {
                "type": "string"
              },
              "image_retention_seconds": {
                "type": "number"
              },
              "created_at": {
                "type": "string"
              },
              "deleted_at": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "tenant_id",
              "name",
              "versioning",
              "image_retention_seconds",
              "created_at"
            ],
            "additionalProperties": false
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": [
        {
          "id": "string",
          "tenant_id": "string",
          "name": "string",
          "versioning": "string",
          "image_retention_seconds": 0,
          "created_at": "string",
          "deleted_at": "string"
        }
      ],
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETList bucket objects in the DashboardDetails +/api/v1/projects/:projectId/storage/buckets/objects

Lists objects under a bucket with optional prefix, search, view, page size and continuation token.

  • Use the continuation token for the next page; do not treat a partial page as the full bucket listing.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
namequeryYesstring—
prefixqueryNostring—
continuationTokenqueryNostring—
pageSizequeryNonumber—
searchqueryNostring—
viewqueryNostring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "objects": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "version_id": {
                    "type": "string"
                  },
                  "bucket": {
                    "type": "string"
                  },
                  "key": {
                    "type": "string"
                  },
                  "size": {
                    "type": "number"
                  },
                  "etag": {
                    "type": "string"
                  },
                  "sha256": {
                    "type": "string"
                  },
                  "content_type": {
                    "type": "string"
                  },
                  "metadata": {
                    "type": "object",
                    "additionalProperties": {
                      "type": "string"
                    }
                  },
                  "delete_marker": {
                    "type": "boolean"
                  },
                  "created_at": {
                    "type": "string"
                  }
                },
                "required": [
                  "version_id",
                  "bucket",
                  "key",
                  "size",
                  "etag",
                  "sha256",
                  "content_type",
                  "created_at"
                ],
                "additionalProperties": false
              }
            },
            "prefixes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "next_token": {
              "type": "string"
            },
            "is_truncated": {
              "type": "boolean"
            }
          },
          "required": [
            "objects",
            "prefixes",
            "is_truncated"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "objects": [
          {
            "version_id": "string",
            "bucket": "string",
            "key": "string",
            "size": 0,
            "etag": "string",
            "sha256": "string",
            "content_type": "string",
            "metadata": null,
            "delete_marker": true,
            "created_at": "string"
          }
        ],
        "prefixes": [
          "string"
        ],
        "next_token": "string",
        "is_truncated": true
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
PUTUpdate bucket settingsDetails +/api/v1/projects/:projectId/storage/buckets/update

Changes bucket versioning and image-variant retention settings.

  • Versioning accepts enabled, suspended or disabled. Retention changes affect newly generated variants according to service rules.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—

JSON request body

FieldType / allowed valuesRequired
namestringYes
versioningdisabled | suspended | enabledYes
imageRetentionSecondsnumberNo
Complete request schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "versioning": {
      "type": "string",
      "enum": [
        "disabled",
        "suspended",
        "enabled"
      ]
    },
    "imageRetentionSeconds": {
      "type": "number"
    }
  },
  "required": [
    "name",
    "versioning"
  ],
  "additionalProperties": false
}
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "tenant_id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "versioning": {
              "type": "string"
            },
            "image_retention_seconds": {
              "type": "number"
            },
            "created_at": {
              "type": "string"
            },
            "deleted_at": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "tenant_id",
            "name",
            "versioning",
            "image_retention_seconds",
            "created_at"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "id": "string",
        "tenant_id": "string",
        "name": "string",
        "versioning": "string",
        "image_retention_seconds": 0,
        "created_at": "string",
        "deleted_at": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETRead storage project overviewDetails +/api/v1/projects/:projectId/storage

Returns storage tenant identity, quota and project-level storage summary.

  • Use usage for time-series usage data and buckets for per-bucket settings.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "state": {
              "type": "string"
            },
            "quotaBytes": {
              "type": "number"
            },
            "bucketCount": {
              "type": "number"
            },
            "buckets": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "tenant_id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "versioning": {
                    "type": "string"
                  },
                  "image_retention_seconds": {
                    "type": "number"
                  },
                  "created_at": {
                    "type": "string"
                  },
                  "deleted_at": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "tenant_id",
                  "name",
                  "versioning",
                  "image_retention_seconds",
                  "created_at"
                ],
                "additionalProperties": false
              }
            },
            "s3Endpoint": {
              "type": "string"
            }
          },
          "required": [
            "state",
            "quotaBytes",
            "bucketCount",
            "buckets"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "state": "string",
        "quotaBytes": 0,
        "bucketCount": 0,
        "buckets": [
          {
            "id": "string",
            "tenant_id": "string",
            "name": "string",
            "versioning": "string",
            "image_retention_seconds": 0,
            "created_at": "string",
            "deleted_at": "string"
          }
        ],
        "s3Endpoint": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
DELETEDelete a bucket objectDetails +/api/v1/projects/:projectId/storage/objects/delete

Deletes the object identified by the bucket and key query parameters.

  • With bucket versioning enabled, deletion may create a delete marker rather than erase prior object versions.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
bucketqueryYesstring—
keyqueryYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "version_id": {
              "type": "string"
            },
            "delete_marker": {
              "type": "boolean"
            }
          },
          "required": [
            "version_id",
            "delete_marker"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "version_id": "string",
        "delete_marker": true
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETCreate an object download responseDetails +/api/v1/projects/:projectId/storage/objects/download

Authorizes and prepares a download for the specified bucket and object key.

  • The response is mediated by the project’s storage access controls; use the S3 API for standard SigV4 clients.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
bucketqueryYesstring—
keyqueryYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "download_url": {
              "type": "string"
            },
            "expires_at": {
              "type": "string"
            }
          },
          "required": [
            "download_url",
            "expires_at"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "download_url": "string",
        "expires_at": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
POSTCreate an object upload sessionDetails +/api/v1/projects/:projectId/storage/objects/upload-session

Returns temporary upload details for sending an object directly to Storage without relaying the bytes through the Dashboard API.

  • Use the returned method, URL and headers exactly. Sessions expire and are scoped to the specified bucket and object key.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—

JSON request body

FieldType / allowed valuesRequired
bucketstringYes
objectKeystringYes
contentTypestringYes
Complete request schema
{
  "type": "object",
  "properties": {
    "bucket": {
      "type": "string"
    },
    "objectKey": {
      "type": "string"
    },
    "contentType": {
      "type": "string"
    }
  },
  "required": [
    "bucket",
    "objectKey",
    "contentType"
  ],
  "additionalProperties": false
}
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "upload_url": {
              "type": "string"
            },
            "object_key": {
              "type": "string"
            },
            "expires_at": {
              "type": "string"
            },
            "content_type": {
              "type": "string"
            }
          },
          "required": [
            "upload_url",
            "object_key",
            "expires_at",
            "content_type"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "upload_url": "string",
        "object_key": "string",
        "expires_at": "string",
        "content_type": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETRead storage usage and quotaDetails +/api/v1/projects/:projectId/storage/usage

Returns current bytes used, quota, active media jobs and available usage series for storage, egress and encoding.

  • Usage figures can lag recent uploads while the service records the latest operation.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "tenant_id": {
              "type": "string"
            },
            "storage_used_bytes": {
              "type": "number"
            },
            "quota_bytes": {
              "type": "number"
            },
            "active_jobs": {
              "type": "number"
            },
            "encode_minutes": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "day": {
                    "type": "string"
                  },
                  "quantity": {
                    "type": "number"
                  }
                },
                "required": [
                  "day",
                  "quantity"
                ],
                "additionalProperties": false
              }
            },
            "egress_bytes": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "day": {
                    "type": "string"
                  },
                  "quantity": {
                    "type": "number"
                  }
                },
                "required": [
                  "day",
                  "quantity"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "tenant_id",
            "storage_used_bytes",
            "quota_bytes",
            "active_jobs",
            "encode_minutes",
            "egress_bytes"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "tenant_id": "string",
        "storage_used_bytes": 0,
        "quota_bytes": 0,
        "active_jobs": 0,
        "encode_minutes": [
          {
            "day": "string",
            "quantity": 0
          }
        ],
        "egress_bytes": [
          {
            "day": "string",
            "quantity": 0
          }
        ]
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }

Related guides

Something unclear or out of date? Emailsupport@hubfly.spaceBack to top