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

Nakama Storage API

Read, write, list, and delete storage objects.

Nakama Storage API is one of 11 APIs that Nakama 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, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, http://127.0.0.1:7350.

4 operations 3 paths 11 schemas 1 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
http://127.0.0.1:7350/v2
Authentication
HTTP Basic, HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Nakama Storage API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic auth using the server key as the username and an empty password. Guards the authenticate endpoints.
  • BearerAuth — The JWT session token returned by an authenticate call, sent as Authorization: Bearer .

Paths & Operations 4

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

Storage 4

Read, write, list, and delete storage objects.

PUT
/v2/storage
Write objects into the storage engine.
writeStorageObjects body → 200
POST
/v2/storage
Get objects from the storage engine.
readStorageObjects body → 200
GET
/v2/storage/{collection}
List publicly readable storage objects in a given collection.
listStorageObjects 4 params → 200
PUT
/v2/storage/delete
Delete one or more objects by id or username.
deleteStorageObjects body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are StorageObject (9 properties), WriteStorageObject (6 properties), StorageObjectAck (4 properties), ReadStorageObjectId (3 properties). Each schema is shown below with its type and property counts.

StorageObject
object
An object within the storage engine.
9 properties
DeleteStorageObjectsRequest
object
1 property
ReadStorageObjectsRequest
object
1 property
ReadStorageObjectId
object
3 properties 2 required
StorageObjectAck
object
4 properties
DeleteStorageObjectId
object
3 properties 2 required
StorageObjectList
object
2 properties
WriteStorageObjectsRequest
object
1 property
StorageObjectAcks
object
1 property
StorageObjects
object
1 property
WriteStorageObject
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nakama-storage-api-openapi.yml Raw ↑

Other APIs Nakama publishes across the network.

Nakama Realtime Socket API
Nakama Console API
Nakama Account API
Nakama Authentication API
Nakama Friends API
Nakama Groups API
Nakama Leaderboards API
Nakama Notifications API
Nakama RPC API
Nakama Tournaments API