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 excludeme API

These operations are not intended to be used directly by clients and should be excluded from client SDKs

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

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

This API exposes 4 operations across 3 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.

4 operations 3 paths 4 schemas 3 GET1 POST

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 excludeme 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 4

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

excludeme 4

These operations are not intended to be used directly by clients and should be excluded from client SDKs

GET
/signin/provider/{provider}/callback
OAuth2 provider callback endpoint
signInProviderCallbackGet 9 params → 302default
POST
/signin/provider/{provider}/callback
OAuth2 provider callback endpoint (formpost)
signInProviderCallbackPost 1 param body → 302default
GET
/files/{id}/presignedurl/contents
Retrieve contents of file
getFileWithPresignedURL 20 params → 200206304412default
GET
/openapi.yaml
Get OpenAPI specification
getOpenAPISpec → 200default

Schemas 4

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

OutputImageFormat
string
Output format for image files. Use 'auto' for content negotiation based on Accept header
RFC2822Date
string
Date in RFC 2822 format
ErrorResponse
object
Standardized error response
3 properties 3 required
ErrorResponse_2
object
Error information returned by the API.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhost-excludeme-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 files API
Nhost operations API
Nhost security API
Nhost session API
Nhost storage API
Nhost system API
Nhost user API