Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nhost storage API

Storage operations and presigned URLs

Nhost storage API is one of 14 APIs that Nhost publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include storage. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://{subdomain}.auth.{region}.nhost.run/v1.

2 operations 2 paths 4 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://{subdomain}.nhost.run/v1/graphql
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nhost storage API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP bearer tokens (BearerAuthElevated).

  • BearerAuth — Bearer authentication with JWT access token. Used to authenticate requests to protected endpoints.
  • BearerAuthElevated — Bearer authentication that requires elevated permissions. Used for sensitive operations that may require additional security measures such as recent authentica…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

storage 2

Storage operations and presigned URLs

GET
/files/{id}/presignedurl
Retrieve presigned URL to retrieve the file
getFilePresignedURL 1 param → 200default
GET
/files/{id}/presignedurl/contents
Retrieve contents of file
getFileWithPresignedURL 20 params → 200206304412default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PresignedURLResponse (2 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error information returned by the API.
1 property
OutputImageFormat
string
Output format for image files. Use 'auto' for content negotiation based on Accept header
RFC2822Date
string
Date in RFC 2822 format
PresignedURLResponse
object
Contains a presigned URL for direct file operations.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhost-storage-api-openapi.yml Raw ↑

Other APIs Nhost publishes across the network.

Nhost GraphQL API
Nhost Serverless Functions API
Nhost AI API
Nhost authentication API
Nhost documentation API
Nhost excludeme API
Nhost files API
Nhost operations API
Nhost security API
Nhost session API
Nhost system API
Nhost user API