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

The Things Network / The Things Stack UserBookmarkRegistry API

The UserBookmarkRegistry API from The Things Network / The Things Stack — 8 operation(s) for userbookmarkregistry.

The Things Network / The Things Stack UserBookmarkRegistry API is one of 58 APIs that The Things Network / The Things Stack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include UserBookmarkRegistry. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.

This API exposes 9 operations across 8 paths, and defines 12 schemas. It is described by OpenAPI 2.0, at version v3.36.

9 operations 8 paths 12 schemas 7 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v3.36
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

The Things Network / The Things Stack UserBookmarkRegistry API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Bearer API key. Set Authorization: Bearer NNSXS.xxxxxxxxxx.

Paths & Operations 9

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

UserBookmarkRegistry 9
GET
/users/{user_ids.user_id}/bookmarks
List the bookmarks for the given user.
UserBookmarkRegistry_List 7 params → 200default
POST
/users/{user_ids.user_id}/bookmarks
Create a bookmark for the given user.
UserBookmarkRegistry_Create 2 params → 200default
DELETE
/users/{user_ids.user_id}/bookmarks/applications/{entity_ids.application_ids.application_id}
Delete the given user's bookmark.
UserBookmarkRegistry_Delete 12 params → 200default
DELETE
/users/{user_ids.user_id}/bookmarks/applications/{entity_ids.device_ids.application_ids.application_id}/devices/{entity_ids.device_ids.device_id}
Delete the given user's bookmark.
UserBookmarkRegistry_Delete6 12 params → 200default
DELETE
/users/{user_ids.user_id}/bookmarks/batch
Delete a list of bookmarks of the given user. This operation is atomic; either all bookmarks are deleted or none. Bookmarks not found are skipped and no error is returned.
UserBookmarkRegistry_BatchDelete 2 params → 200default
DELETE
/users/{user_ids.user_id}/bookmarks/clients/{entity_ids.client_ids.client_id}
Delete the given user's bookmark.
UserBookmarkRegistry_Delete2 13 params → 200default
DELETE
/users/{user_ids.user_id}/bookmarks/gateways/{entity_ids.gateway_ids.gateway_id}
Delete the given user's bookmark.
UserBookmarkRegistry_Delete3 13 params → 200default
DELETE
/users/{user_ids.user_id}/bookmarks/organizations/{entity_ids.organization_ids.organization_id}
Delete the given user's bookmark.
UserBookmarkRegistry_Delete4 13 params → 200default
DELETE
/users/{user_ids.user_id}/bookmarks/users/{entity_ids.user_ids.user_id}
Delete the given user's bookmark.
UserBookmarkRegistry_Delete5 14 params → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are v3EntityIdentifiers (6 properties), v3EndDeviceIdentifiers (5 properties), v3UserBookmark (3 properties), googlerpcStatus (3 properties). Each schema is shown below with its type and property counts.

v3UserBookmarks
object
1 property
googlerpcStatus
object
3 properties
v3EntityIdentifiers
object
EntityIdentifiers contains one of the possible entity identifiers.
6 properties
v3UserBookmarkRegistryCreateBody
object
2 properties
v3UserBookmark
object
3 properties
v3EndDeviceIdentifiers
object
5 properties
v3ApplicationIdentifiers
object
1 property
lorawanv3GatewayIdentifiers
object
2 properties
v3UserIdentifiers
object
2 properties
v3ClientIdentifiers
object
1 property
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
v3OrganizationIdentifiers
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-things-network-userbookmarkregistry-api-openapi.yml Raw ↑

Other APIs The Things Network / The Things Stack publishes across the network.

The Things Network / The Things Stack AppAs API
The Things Network / The Things Stack ApplicationAccess API
The Things Network / The Things Stack ApplicationActivationSettingRegistry API
The Things Network / The Things Stack ApplicationPackageRegistry API
The Things Network / The Things Stack ApplicationPubSubRegistry API
The Things Network / The Things Stack ApplicationRegistry API
The Things Network / The Things Stack ApplicationUpStorage API
The Things Network / The Things Stack ApplicationWebhookRegistry API
The Things Network / The Things Stack As API
The Things Network / The Things Stack AsEndDeviceBatchRegistry API
The Things Network / The Things Stack AsEndDeviceRegistry API
The Things Network / The Things Stack ClientAccess API